vkcs 0.9.3, Apr 15 25

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vkcs.BackupPlan

Explore with Pulumi AI

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vk-cs/terraform-provider-vkcs

Example Usage

Incremental backup for compute instance

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.BackupPlan;
import com.pulumi.vkcs.BackupPlanArgs;
import com.pulumi.vkcs.inputs.BackupPlanScheduleArgs;
import com.pulumi.vkcs.inputs.BackupPlanFullRetentionArgs;
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 backupPlan = new BackupPlan("backupPlan", BackupPlanArgs.builder()
            .providerName("cloud_servers")
            .incrementalBackup(true)
            .schedule(BackupPlanScheduleArgs.builder()
                .date("Mo")
                .time("04:00+03")
                .build())
            .fullRetention(BackupPlanFullRetentionArgs.builder()
                .max_full_backup(25)
                .build())
            .instanceIds(vkcs_compute_instance.basic().id())
            .build());

    }
}

resources:
  backupPlan:
    type: vkcs:BackupPlan
    properties:
      providerName: cloud_servers
      incrementalBackup: true
      # Create full backup every Monday at 04:00 MSK
      #   # Incremental backups are created each other day at the same time
      schedule:
        date:
          - Mo
        time: 04:00+03
      fullRetention:
        max_full_backup: 25
      instanceIds:
        - ${vkcs_compute_instance.basic.id}

Full backup with GFS retention policy for compute instance

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.BackupPlan;
import com.pulumi.vkcs.BackupPlanArgs;
import com.pulumi.vkcs.inputs.BackupPlanScheduleArgs;
import com.pulumi.vkcs.inputs.BackupPlanGfsRetentionArgs;
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 backupPlan = new BackupPlan("backupPlan", BackupPlanArgs.builder()
            .providerName("cloud_servers")
            .incrementalBackup(false)
            .schedule(BackupPlanScheduleArgs.builder()
                .date(                
                    "Mo",
                    "We",
                    "Fr")
                .time("23:00")
                .build())
            .gfsRetention(BackupPlanGfsRetentionArgs.builder()
                .gfs_weekly(4)
                .gfs_monthly(11)
                .gfs_yearly(2)
                .build())
            .instanceIds(vkcs_compute_instance.basic().id())
            .build());

    }
}

resources:
  backupPlan:
    type: vkcs:BackupPlan
    properties:
      providerName: cloud_servers
      incrementalBackup: false
      # Backup the instance three times in week at 23:00 (02:00 MSK next day)
      schedule:
        date:
          - Mo
          - We
          - Fr
        time: 23:00
      # Keep backups: one for every last four weeks, one for every month of the last year, one for last two years
      gfsRetention:
        gfs_weekly: 4
        gfs_monthly: 11
        gfs_yearly: 2
      instanceIds:
        - ${vkcs_compute_instance.basic.id}

Backup for db instance

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.BackupPlan;
import com.pulumi.vkcs.BackupPlanArgs;
import com.pulumi.vkcs.inputs.BackupPlanScheduleArgs;
import com.pulumi.vkcs.inputs.BackupPlanFullRetentionArgs;
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 backupPlan = new BackupPlan("backupPlan", BackupPlanArgs.builder()
            .providerName("dbaas")
            .incrementalBackup(false)
            .schedule(BackupPlanScheduleArgs.builder()
                .every_hours(12)
                .build())
            .fullRetention(BackupPlanFullRetentionArgs.builder()
                .max_full_backup(25)
                .build())
            .instanceIds(vkcs_db_instance.mysql().id())
            .build());

    }
}

resources:
  backupPlan:
    type: vkcs:BackupPlan
    properties:
      providerName: dbaas
      # Must be false since DBaaS does not support incremental backups
      incrementalBackup: false
      # Backup database data every 12 hours since the next hour after the plan creation
      schedule:
        every_hours: 12
      fullRetention:
        max_full_backup: 25
      instanceIds:
        - ${vkcs_db_instance.mysql.id}

Create BackupPlan Resource

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

Constructor syntax

new BackupPlan(name: string, args: BackupPlanArgs, opts?: CustomResourceOptions);

@overload
def BackupPlan(resource_name: str,
               args: BackupPlanArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def BackupPlan(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               incremental_backup: Optional[bool] = None,
               instance_ids: Optional[Sequence[str]] = None,
               schedule: Optional[BackupPlanScheduleArgs] = None,
               full_retention: Optional[BackupPlanFullRetentionArgs] = None,
               gfs_retention: Optional[BackupPlanGfsRetentionArgs] = None,
               name: Optional[str] = None,
               provider_id: Optional[str] = None,
               provider_name: Optional[str] = None,
               region: Optional[str] = None)

func NewBackupPlan(ctx *Context, name string, args BackupPlanArgs, opts ...ResourceOption) (*BackupPlan, error)

public BackupPlan(string name, BackupPlanArgs args, CustomResourceOptions? opts = null)

public BackupPlan(String name, BackupPlanArgs args)
public BackupPlan(String name, BackupPlanArgs args, CustomResourceOptions options)

type: vkcs:BackupPlan
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 BackupPlanArgs: 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 BackupPlanArgs: 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 BackupPlanArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BackupPlanArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BackupPlanArgs: 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 backupPlanResource = new Vkcs.BackupPlan("backupPlanResource", new()
{
    IncrementalBackup = false,
    InstanceIds = new[]
    {
        "string",
    },
    Schedule = new Vkcs.Inputs.BackupPlanScheduleArgs
    {
        Dates = new[]
        {
            "string",
        },
        EveryHours = 0,
        Time = "string",
    },
    FullRetention = new Vkcs.Inputs.BackupPlanFullRetentionArgs
    {
        MaxFullBackup = 0,
    },
    GfsRetention = new Vkcs.Inputs.BackupPlanGfsRetentionArgs
    {
        GfsWeekly = 0,
        GfsMonthly = 0,
        GfsYearly = 0,
    },
    Name = "string",
    ProviderId = "string",
    ProviderName = "string",
    Region = "string",
});

example, err := vkcs.NewBackupPlan(ctx, "backupPlanResource", &vkcs.BackupPlanArgs{
	IncrementalBackup: pulumi.Bool(false),
	InstanceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Schedule: &vkcs.BackupPlanScheduleArgs{
		Dates: pulumi.StringArray{
			pulumi.String("string"),
		},
		EveryHours: pulumi.Float64(0),
		Time:       pulumi.String("string"),
	},
	FullRetention: &vkcs.BackupPlanFullRetentionArgs{
		MaxFullBackup: pulumi.Float64(0),
	},
	GfsRetention: &vkcs.BackupPlanGfsRetentionArgs{
		GfsWeekly:  pulumi.Float64(0),
		GfsMonthly: pulumi.Float64(0),
		GfsYearly:  pulumi.Float64(0),
	},
	Name:         pulumi.String("string"),
	ProviderId:   pulumi.String("string"),
	ProviderName: pulumi.String("string"),
	Region:       pulumi.String("string"),
})

var backupPlanResource = new BackupPlan("backupPlanResource", BackupPlanArgs.builder()
    .incrementalBackup(false)
    .instanceIds("string")
    .schedule(BackupPlanScheduleArgs.builder()
        .dates("string")
        .everyHours(0)
        .time("string")
        .build())
    .fullRetention(BackupPlanFullRetentionArgs.builder()
        .maxFullBackup(0)
        .build())
    .gfsRetention(BackupPlanGfsRetentionArgs.builder()
        .gfsWeekly(0)
        .gfsMonthly(0)
        .gfsYearly(0)
        .build())
    .name("string")
    .providerId("string")
    .providerName("string")
    .region("string")
    .build());

backup_plan_resource = vkcs.BackupPlan("backupPlanResource",
    incremental_backup=False,
    instance_ids=["string"],
    schedule={
        "dates": ["string"],
        "every_hours": 0,
        "time": "string",
    },
    full_retention={
        "max_full_backup": 0,
    },
    gfs_retention={
        "gfs_weekly": 0,
        "gfs_monthly": 0,
        "gfs_yearly": 0,
    },
    name="string",
    provider_id="string",
    provider_name="string",
    region="string")

const backupPlanResource = new vkcs.BackupPlan("backupPlanResource", {
    incrementalBackup: false,
    instanceIds: ["string"],
    schedule: {
        dates: ["string"],
        everyHours: 0,
        time: "string",
    },
    fullRetention: {
        maxFullBackup: 0,
    },
    gfsRetention: {
        gfsWeekly: 0,
        gfsMonthly: 0,
        gfsYearly: 0,
    },
    name: "string",
    providerId: "string",
    providerName: "string",
    region: "string",
});

type: vkcs:BackupPlan
properties:
    fullRetention:
        maxFullBackup: 0
    gfsRetention:
        gfsMonthly: 0
        gfsWeekly: 0
        gfsYearly: 0
    incrementalBackup: false
    instanceIds:
        - string
    name: string
    providerId: string
    providerName: string
    region: string
    schedule:
        dates:
            - string
        everyHours: 0
        time: string

BackupPlan Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The BackupPlan resource accepts the following input properties:

IncrementalBackup bool: required boolean → Whether incremental backups strategy should be used. If enabled, the schedule.date field must specify one day, on which full backup will be created. On other days, incremental backups will be created. Note: This option may be enabled for only for 'cloud_servers' provider.
InstanceIds List<string>: required string → List of ids of instances to make backup for
Schedule BackupPlanSchedule: required
FullRetention BackupPlanFullRetention: optional → Parameters for full retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with gfs_retention
GfsRetention BackupPlanGfsRetention: optional → Parameters for gfs retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with full_retention
Name string: required string → Name of the backup plan
ProviderId string: optional string → ID of backup provider
ProviderName string: optional string → Name of backup provider, must be one of: cloud_servers, dbaas
Region string: optional string → The region to fetch availability zones from, defaults to the provider's region.

IncrementalBackup bool: required boolean → Whether incremental backups strategy should be used. If enabled, the schedule.date field must specify one day, on which full backup will be created. On other days, incremental backups will be created. Note: This option may be enabled for only for 'cloud_servers' provider.
InstanceIds []string: required string → List of ids of instances to make backup for
Schedule BackupPlanScheduleArgs: required
FullRetention BackupPlanFullRetentionArgs: optional → Parameters for full retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with gfs_retention
GfsRetention BackupPlanGfsRetentionArgs: optional → Parameters for gfs retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with full_retention
Name string: required string → Name of the backup plan
ProviderId string: optional string → ID of backup provider
ProviderName string: optional string → Name of backup provider, must be one of: cloud_servers, dbaas
Region string: optional string → The region to fetch availability zones from, defaults to the provider's region.

incrementalBackup Boolean: required boolean → Whether incremental backups strategy should be used. If enabled, the schedule.date field must specify one day, on which full backup will be created. On other days, incremental backups will be created. Note: This option may be enabled for only for 'cloud_servers' provider.
instanceIds List<String>: required string → List of ids of instances to make backup for
schedule BackupPlanSchedule: required
fullRetention BackupPlanFullRetention: optional → Parameters for full retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with gfs_retention
gfsRetention BackupPlanGfsRetention: optional → Parameters for gfs retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with full_retention
name String: required string → Name of the backup plan
providerId String: optional string → ID of backup provider
providerName String: optional string → Name of backup provider, must be one of: cloud_servers, dbaas
region String: optional string → The region to fetch availability zones from, defaults to the provider's region.

incrementalBackup boolean: required boolean → Whether incremental backups strategy should be used. If enabled, the schedule.date field must specify one day, on which full backup will be created. On other days, incremental backups will be created. Note: This option may be enabled for only for 'cloud_servers' provider.
instanceIds string[]: required string → List of ids of instances to make backup for
schedule BackupPlanSchedule: required
fullRetention BackupPlanFullRetention: optional → Parameters for full retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with gfs_retention
gfsRetention BackupPlanGfsRetention: optional → Parameters for gfs retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with full_retention
name string: required string → Name of the backup plan
providerId string: optional string → ID of backup provider
providerName string: optional string → Name of backup provider, must be one of: cloud_servers, dbaas
region string: optional string → The region to fetch availability zones from, defaults to the provider's region.

incremental_backup bool: required boolean → Whether incremental backups strategy should be used. If enabled, the schedule.date field must specify one day, on which full backup will be created. On other days, incremental backups will be created. Note: This option may be enabled for only for 'cloud_servers' provider.
instance_ids Sequence[str]: required string → List of ids of instances to make backup for
schedule BackupPlanScheduleArgs: required
full_retention BackupPlanFullRetentionArgs: optional → Parameters for full retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with gfs_retention
gfs_retention BackupPlanGfsRetentionArgs: optional → Parameters for gfs retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with full_retention
name str: required string → Name of the backup plan
provider_id str: optional string → ID of backup provider
provider_name str: optional string → Name of backup provider, must be one of: cloud_servers, dbaas
region str: optional string → The region to fetch availability zones from, defaults to the provider's region.

incrementalBackup Boolean: required boolean → Whether incremental backups strategy should be used. If enabled, the schedule.date field must specify one day, on which full backup will be created. On other days, incremental backups will be created. Note: This option may be enabled for only for 'cloud_servers' provider.
instanceIds List<String>: required string → List of ids of instances to make backup for
schedule Property Map: required
fullRetention Property Map: optional → Parameters for full retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with gfs_retention
gfsRetention Property Map: optional → Parameters for gfs retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with full_retention
name String: required string → Name of the backup plan
providerId String: optional string → ID of backup provider
providerName String: optional string → Name of backup provider, must be one of: cloud_servers, dbaas
region String: optional string → The region to fetch availability zones from, defaults to the provider's region.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing BackupPlan Resource

Get an existing BackupPlan 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?: BackupPlanState, opts?: CustomResourceOptions): BackupPlan

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        full_retention: Optional[BackupPlanFullRetentionArgs] = None,
        gfs_retention: Optional[BackupPlanGfsRetentionArgs] = None,
        incremental_backup: Optional[bool] = None,
        instance_ids: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        provider_id: Optional[str] = None,
        provider_name: Optional[str] = None,
        region: Optional[str] = None,
        schedule: Optional[BackupPlanScheduleArgs] = None) -> BackupPlan

func GetBackupPlan(ctx *Context, name string, id IDInput, state *BackupPlanState, opts ...ResourceOption) (*BackupPlan, error)

public static BackupPlan Get(string name, Input<string> id, BackupPlanState? state, CustomResourceOptions? opts = null)

public static BackupPlan get(String name, Output<String> id, BackupPlanState state, CustomResourceOptions options)

resources:  _:    type: vkcs:BackupPlan    get:      id: ${id}

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:

FullRetention BackupPlanFullRetention: optional → Parameters for full retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with gfs_retention
GfsRetention BackupPlanGfsRetention: optional → Parameters for gfs retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with full_retention
IncrementalBackup bool: required boolean → Whether incremental backups strategy should be used. If enabled, the schedule.date field must specify one day, on which full backup will be created. On other days, incremental backups will be created. Note: This option may be enabled for only for 'cloud_servers' provider.
InstanceIds List<string>: required string → List of ids of instances to make backup for
Name string: required string → Name of the backup plan
ProviderId string: optional string → ID of backup provider
ProviderName string: optional string → Name of backup provider, must be one of: cloud_servers, dbaas
Region string: optional string → The region to fetch availability zones from, defaults to the provider's region.
Schedule BackupPlanSchedule: required

FullRetention BackupPlanFullRetentionArgs: optional → Parameters for full retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with gfs_retention
GfsRetention BackupPlanGfsRetentionArgs: optional → Parameters for gfs retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with full_retention
IncrementalBackup bool: required boolean → Whether incremental backups strategy should be used. If enabled, the schedule.date field must specify one day, on which full backup will be created. On other days, incremental backups will be created. Note: This option may be enabled for only for 'cloud_servers' provider.
InstanceIds []string: required string → List of ids of instances to make backup for
Name string: required string → Name of the backup plan
ProviderId string: optional string → ID of backup provider
ProviderName string: optional string → Name of backup provider, must be one of: cloud_servers, dbaas
Region string: optional string → The region to fetch availability zones from, defaults to the provider's region.
Schedule BackupPlanScheduleArgs: required

fullRetention BackupPlanFullRetention: optional → Parameters for full retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with gfs_retention
gfsRetention BackupPlanGfsRetention: optional → Parameters for gfs retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with full_retention
incrementalBackup Boolean: required boolean → Whether incremental backups strategy should be used. If enabled, the schedule.date field must specify one day, on which full backup will be created. On other days, incremental backups will be created. Note: This option may be enabled for only for 'cloud_servers' provider.
instanceIds List<String>: required string → List of ids of instances to make backup for
name String: required string → Name of the backup plan
providerId String: optional string → ID of backup provider
providerName String: optional string → Name of backup provider, must be one of: cloud_servers, dbaas
region String: optional string → The region to fetch availability zones from, defaults to the provider's region.
schedule BackupPlanSchedule: required

fullRetention BackupPlanFullRetention: optional → Parameters for full retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with gfs_retention
gfsRetention BackupPlanGfsRetention: optional → Parameters for gfs retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with full_retention
incrementalBackup boolean: required boolean → Whether incremental backups strategy should be used. If enabled, the schedule.date field must specify one day, on which full backup will be created. On other days, incremental backups will be created. Note: This option may be enabled for only for 'cloud_servers' provider.
instanceIds string[]: required string → List of ids of instances to make backup for
name string: required string → Name of the backup plan
providerId string: optional string → ID of backup provider
providerName string: optional string → Name of backup provider, must be one of: cloud_servers, dbaas
region string: optional string → The region to fetch availability zones from, defaults to the provider's region.
schedule BackupPlanSchedule: required

full_retention BackupPlanFullRetentionArgs: optional → Parameters for full retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with gfs_retention
gfs_retention BackupPlanGfsRetentionArgs: optional → Parameters for gfs retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with full_retention
incremental_backup bool: required boolean → Whether incremental backups strategy should be used. If enabled, the schedule.date field must specify one day, on which full backup will be created. On other days, incremental backups will be created. Note: This option may be enabled for only for 'cloud_servers' provider.
instance_ids Sequence[str]: required string → List of ids of instances to make backup for
name str: required string → Name of the backup plan
provider_id str: optional string → ID of backup provider
provider_name str: optional string → Name of backup provider, must be one of: cloud_servers, dbaas
region str: optional string → The region to fetch availability zones from, defaults to the provider's region.
schedule BackupPlanScheduleArgs: required

fullRetention Property Map: optional → Parameters for full retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with gfs_retention
gfsRetention Property Map: optional → Parameters for gfs retention policy. Specifies number of full backups stored. Incremental backups (if enabled) are not counted as full. Incompatible with full_retention
incrementalBackup Boolean: required boolean → Whether incremental backups strategy should be used. If enabled, the schedule.date field must specify one day, on which full backup will be created. On other days, incremental backups will be created. Note: This option may be enabled for only for 'cloud_servers' provider.
instanceIds List<String>: required string → List of ids of instances to make backup for
name String: required string → Name of the backup plan
providerId String: optional string → ID of backup provider
providerName String: optional string → Name of backup provider, must be one of: cloud_servers, dbaas
region String: optional string → The region to fetch availability zones from, defaults to the provider's region.
schedule Property Map: required

Supporting Types

BackupPlanFullRetention, BackupPlanFullRetentionArgs

MaxFullBackup double: required number → Maximum number of backups

MaxFullBackup float64: required number → Maximum number of backups

maxFullBackup Double: required number → Maximum number of backups

maxFullBackup number: required number → Maximum number of backups

max_full_backup float: required number → Maximum number of backups

maxFullBackup Number: required number → Maximum number of backups

BackupPlanGfsRetention, BackupPlanGfsRetentionArgs

GfsWeekly double: required number → Number of weeks to store backups
GfsMonthly double: optional number → Number of months to store backups
GfsYearly double: optional number → Number of years to store backups

GfsWeekly float64: required number → Number of weeks to store backups
GfsMonthly float64: optional number → Number of months to store backups
GfsYearly float64: optional number → Number of years to store backups

gfsWeekly Double: required number → Number of weeks to store backups
gfsMonthly Double: optional number → Number of months to store backups
gfsYearly Double: optional number → Number of years to store backups

gfsWeekly number: required number → Number of weeks to store backups
gfsMonthly number: optional number → Number of months to store backups
gfsYearly number: optional number → Number of years to store backups

gfs_weekly float: required number → Number of weeks to store backups
gfs_monthly float: optional number → Number of months to store backups
gfs_yearly float: optional number → Number of years to store backups

gfsWeekly Number: required number → Number of weeks to store backups
gfsMonthly Number: optional number → Number of months to store backups
gfsYearly Number: optional number → Number of years to store backups

BackupPlanSchedule, BackupPlanScheduleArgs

Dates List<string>: optional string → List of days when to perform backups. If incremental_backups is enabled, only one day should be specified
EveryHours double: optional number → Hour interval of backups, must be one of: 3, 12, 24. This field is incompatible with date/time fields
Time string: optional string → Time of backup in format hh:mm (for UTC timezone) or hh:mm+tz (for other timezones, e.g. 10:00+03 for MSK, 10:00-04 for ET)

Dates []string: optional string → List of days when to perform backups. If incremental_backups is enabled, only one day should be specified
EveryHours float64: optional number → Hour interval of backups, must be one of: 3, 12, 24. This field is incompatible with date/time fields
Time string: optional string → Time of backup in format hh:mm (for UTC timezone) or hh:mm+tz (for other timezones, e.g. 10:00+03 for MSK, 10:00-04 for ET)

dates List<String>: optional string → List of days when to perform backups. If incremental_backups is enabled, only one day should be specified
everyHours Double: optional number → Hour interval of backups, must be one of: 3, 12, 24. This field is incompatible with date/time fields
time String: optional string → Time of backup in format hh:mm (for UTC timezone) or hh:mm+tz (for other timezones, e.g. 10:00+03 for MSK, 10:00-04 for ET)

dates string[]: optional string → List of days when to perform backups. If incremental_backups is enabled, only one day should be specified
everyHours number: optional number → Hour interval of backups, must be one of: 3, 12, 24. This field is incompatible with date/time fields
time string: optional string → Time of backup in format hh:mm (for UTC timezone) or hh:mm+tz (for other timezones, e.g. 10:00+03 for MSK, 10:00-04 for ET)

dates Sequence[str]: optional string → List of days when to perform backups. If incremental_backups is enabled, only one day should be specified
every_hours float: optional number → Hour interval of backups, must be one of: 3, 12, 24. This field is incompatible with date/time fields
time str: optional string → Time of backup in format hh:mm (for UTC timezone) or hh:mm+tz (for other timezones, e.g. 10:00+03 for MSK, 10:00-04 for ET)

dates List<String>: optional string → List of days when to perform backups. If incremental_backups is enabled, only one day should be specified
everyHours Number: optional number → Hour interval of backups, must be one of: 3, 12, 24. This field is incompatible with date/time fields
time String: optional string → Time of backup in format hh:mm (for UTC timezone) or hh:mm+tz (for other timezones, e.g. 10:00+03 for MSK, 10:00-04 for ET)

Import

Backup plan can be imported using the name, e.g.

$ pulumi import vkcs:index/backupPlan:BackupPlan mybackupplan 5dfe75cb-a00f-4bc8-9551-bd38f64747e7

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

Package Details

Repository: vkcs vk-cs/terraform-provider-vkcs
License
Notes: This Pulumi package is based on the vkcs Terraform Provider.

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vk-cs/terraform-provider-vkcs

vkcs.BackupPlan

On this page

On this page

Example Usage

Incremental backup for compute instance

Full backup with GFS retention policy for compute instance

Backup for db instance

Create BackupPlan Resource

Constructor syntax

Parameters

Constructor example

BackupPlan Resource Properties

Inputs

Outputs

Look up Existing BackupPlan Resource

Supporting Types

BackupPlanFullRetention, BackupPlanFullRetentionArgs

BackupPlanGfsRetention, BackupPlanGfsRetentionArgs

BackupPlanSchedule, BackupPlanScheduleArgs

Import

Package Details

On this page

On this page