1. Packages
  2. stackit
  3. API Docs
  4. ServerBackupSchedule
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
stackit logo
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud

    Server backup schedule resource schema. Must have a region specified in the provider configuration.

    This resource is in beta and may be subject to breaking changes in the future. Use with caution. See our guide for how to opt-in to use beta resources.

    Example Usage

    resource "stackit_server_backup_schedule" "example" {
      project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      server_id  = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      name       = "example_backup_schedule_name"
      rrule      = "DTSTART;TZID=Europe/Sofia:20200803T023000 RRULE:FREQ=DAILY;INTERVAL=1"
      enabled    = true
      backup_properties = {
        name             = "example_backup_name"
        retention_period = 14
        volume_ids       = null
      }
    }
    
    # Only use the import statement, if you want to import an existing server backup schedule
    import {
      to = stackit_server_backup_schedule.import-example
      id = "${var.project_id},${var.region},${var.server_id},${var.server_backup_schedule_id}"
    }
    

    Create ServerBackupSchedule Resource

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

    Constructor syntax

    new ServerBackupSchedule(name: string, args: ServerBackupScheduleArgs, opts?: CustomResourceOptions);
    @overload
    def ServerBackupSchedule(resource_name: str,
                             args: ServerBackupScheduleArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def ServerBackupSchedule(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             backup_properties: Optional[ServerBackupScheduleBackupPropertiesArgs] = None,
                             enabled: Optional[bool] = None,
                             project_id: Optional[str] = None,
                             rrule: Optional[str] = None,
                             server_id: Optional[str] = None,
                             name: Optional[str] = None,
                             region: Optional[str] = None)
    func NewServerBackupSchedule(ctx *Context, name string, args ServerBackupScheduleArgs, opts ...ResourceOption) (*ServerBackupSchedule, error)
    public ServerBackupSchedule(string name, ServerBackupScheduleArgs args, CustomResourceOptions? opts = null)
    public ServerBackupSchedule(String name, ServerBackupScheduleArgs args)
    public ServerBackupSchedule(String name, ServerBackupScheduleArgs args, CustomResourceOptions options)
    
    type: stackit:ServerBackupSchedule
    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 ServerBackupScheduleArgs
    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 ServerBackupScheduleArgs
    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 ServerBackupScheduleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServerBackupScheduleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServerBackupScheduleArgs
    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 serverBackupScheduleResource = new Stackit.ServerBackupSchedule("serverBackupScheduleResource", new()
    {
        BackupProperties = new Stackit.Inputs.ServerBackupScheduleBackupPropertiesArgs
        {
            Name = "string",
            RetentionPeriod = 0,
            VolumeIds = new[]
            {
                "string",
            },
        },
        Enabled = false,
        ProjectId = "string",
        Rrule = "string",
        ServerId = "string",
        Name = "string",
        Region = "string",
    });
    
    example, err := stackit.NewServerBackupSchedule(ctx, "serverBackupScheduleResource", &stackit.ServerBackupScheduleArgs{
    	BackupProperties: &stackit.ServerBackupScheduleBackupPropertiesArgs{
    		Name:            pulumi.String("string"),
    		RetentionPeriod: pulumi.Int(0),
    		VolumeIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	Enabled:   pulumi.Bool(false),
    	ProjectId: pulumi.String("string"),
    	Rrule:     pulumi.String("string"),
    	ServerId:  pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	Region:    pulumi.String("string"),
    })
    
    var serverBackupScheduleResource = new ServerBackupSchedule("serverBackupScheduleResource", ServerBackupScheduleArgs.builder()
        .backupProperties(ServerBackupScheduleBackupPropertiesArgs.builder()
            .name("string")
            .retentionPeriod(0)
            .volumeIds("string")
            .build())
        .enabled(false)
        .projectId("string")
        .rrule("string")
        .serverId("string")
        .name("string")
        .region("string")
        .build());
    
    server_backup_schedule_resource = stackit.ServerBackupSchedule("serverBackupScheduleResource",
        backup_properties={
            "name": "string",
            "retention_period": 0,
            "volume_ids": ["string"],
        },
        enabled=False,
        project_id="string",
        rrule="string",
        server_id="string",
        name="string",
        region="string")
    
    const serverBackupScheduleResource = new stackit.ServerBackupSchedule("serverBackupScheduleResource", {
        backupProperties: {
            name: "string",
            retentionPeriod: 0,
            volumeIds: ["string"],
        },
        enabled: false,
        projectId: "string",
        rrule: "string",
        serverId: "string",
        name: "string",
        region: "string",
    });
    
    type: stackit:ServerBackupSchedule
    properties:
        backupProperties:
            name: string
            retentionPeriod: 0
            volumeIds:
                - string
        enabled: false
        name: string
        projectId: string
        region: string
        rrule: string
        serverId: string
    

    ServerBackupSchedule 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 ServerBackupSchedule resource accepts the following input properties:

    BackupProperties ServerBackupScheduleBackupProperties
    Backup schedule details for the backups.
    Enabled bool
    Is the backup schedule enabled or disabled.
    ProjectId string
    STACKIT Project ID to which the server is associated.
    Rrule string
    An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
    ServerId string
    Server ID for the backup schedule.
    Name string
    The schedule name.
    Region string
    The resource region. If not defined, the provider region is used.
    BackupProperties ServerBackupScheduleBackupPropertiesArgs
    Backup schedule details for the backups.
    Enabled bool
    Is the backup schedule enabled or disabled.
    ProjectId string
    STACKIT Project ID to which the server is associated.
    Rrule string
    An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
    ServerId string
    Server ID for the backup schedule.
    Name string
    The schedule name.
    Region string
    The resource region. If not defined, the provider region is used.
    backupProperties ServerBackupScheduleBackupProperties
    Backup schedule details for the backups.
    enabled Boolean
    Is the backup schedule enabled or disabled.
    projectId String
    STACKIT Project ID to which the server is associated.
    rrule String
    An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
    serverId String
    Server ID for the backup schedule.
    name String
    The schedule name.
    region String
    The resource region. If not defined, the provider region is used.
    backupProperties ServerBackupScheduleBackupProperties
    Backup schedule details for the backups.
    enabled boolean
    Is the backup schedule enabled or disabled.
    projectId string
    STACKIT Project ID to which the server is associated.
    rrule string
    An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
    serverId string
    Server ID for the backup schedule.
    name string
    The schedule name.
    region string
    The resource region. If not defined, the provider region is used.
    backup_properties ServerBackupScheduleBackupPropertiesArgs
    Backup schedule details for the backups.
    enabled bool
    Is the backup schedule enabled or disabled.
    project_id str
    STACKIT Project ID to which the server is associated.
    rrule str
    An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
    server_id str
    Server ID for the backup schedule.
    name str
    The schedule name.
    region str
    The resource region. If not defined, the provider region is used.
    backupProperties Property Map
    Backup schedule details for the backups.
    enabled Boolean
    Is the backup schedule enabled or disabled.
    projectId String
    STACKIT Project ID to which the server is associated.
    rrule String
    An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
    serverId String
    Server ID for the backup schedule.
    name String
    The schedule name.
    region String
    The resource region. If not defined, the provider region is used.

    Outputs

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

    BackupScheduleId int
    Backup schedule ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    BackupScheduleId int
    Backup schedule ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    backupScheduleId Integer
    Backup schedule ID.
    id String
    The provider-assigned unique ID for this managed resource.
    backupScheduleId number
    Backup schedule ID.
    id string
    The provider-assigned unique ID for this managed resource.
    backup_schedule_id int
    Backup schedule ID.
    id str
    The provider-assigned unique ID for this managed resource.
    backupScheduleId Number
    Backup schedule ID.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ServerBackupSchedule Resource

    Get an existing ServerBackupSchedule 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?: ServerBackupScheduleState, opts?: CustomResourceOptions): ServerBackupSchedule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backup_properties: Optional[ServerBackupScheduleBackupPropertiesArgs] = None,
            backup_schedule_id: Optional[int] = None,
            enabled: Optional[bool] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            region: Optional[str] = None,
            rrule: Optional[str] = None,
            server_id: Optional[str] = None) -> ServerBackupSchedule
    func GetServerBackupSchedule(ctx *Context, name string, id IDInput, state *ServerBackupScheduleState, opts ...ResourceOption) (*ServerBackupSchedule, error)
    public static ServerBackupSchedule Get(string name, Input<string> id, ServerBackupScheduleState? state, CustomResourceOptions? opts = null)
    public static ServerBackupSchedule get(String name, Output<String> id, ServerBackupScheduleState state, CustomResourceOptions options)
    resources:  _:    type: stackit:ServerBackupSchedule    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:
    BackupProperties ServerBackupScheduleBackupProperties
    Backup schedule details for the backups.
    BackupScheduleId int
    Backup schedule ID.
    Enabled bool
    Is the backup schedule enabled or disabled.
    Name string
    The schedule name.
    ProjectId string
    STACKIT Project ID to which the server is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    Rrule string
    An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
    ServerId string
    Server ID for the backup schedule.
    BackupProperties ServerBackupScheduleBackupPropertiesArgs
    Backup schedule details for the backups.
    BackupScheduleId int
    Backup schedule ID.
    Enabled bool
    Is the backup schedule enabled or disabled.
    Name string
    The schedule name.
    ProjectId string
    STACKIT Project ID to which the server is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    Rrule string
    An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
    ServerId string
    Server ID for the backup schedule.
    backupProperties ServerBackupScheduleBackupProperties
    Backup schedule details for the backups.
    backupScheduleId Integer
    Backup schedule ID.
    enabled Boolean
    Is the backup schedule enabled or disabled.
    name String
    The schedule name.
    projectId String
    STACKIT Project ID to which the server is associated.
    region String
    The resource region. If not defined, the provider region is used.
    rrule String
    An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
    serverId String
    Server ID for the backup schedule.
    backupProperties ServerBackupScheduleBackupProperties
    Backup schedule details for the backups.
    backupScheduleId number
    Backup schedule ID.
    enabled boolean
    Is the backup schedule enabled or disabled.
    name string
    The schedule name.
    projectId string
    STACKIT Project ID to which the server is associated.
    region string
    The resource region. If not defined, the provider region is used.
    rrule string
    An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
    serverId string
    Server ID for the backup schedule.
    backup_properties ServerBackupScheduleBackupPropertiesArgs
    Backup schedule details for the backups.
    backup_schedule_id int
    Backup schedule ID.
    enabled bool
    Is the backup schedule enabled or disabled.
    name str
    The schedule name.
    project_id str
    STACKIT Project ID to which the server is associated.
    region str
    The resource region. If not defined, the provider region is used.
    rrule str
    An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
    server_id str
    Server ID for the backup schedule.
    backupProperties Property Map
    Backup schedule details for the backups.
    backupScheduleId Number
    Backup schedule ID.
    enabled Boolean
    Is the backup schedule enabled or disabled.
    name String
    The schedule name.
    projectId String
    STACKIT Project ID to which the server is associated.
    region String
    The resource region. If not defined, the provider region is used.
    rrule String
    An rrule (Recurrence Rule) is a standardized string format used in iCalendar (RFC 5545) to define repeating events, and you can generate one by using a dedicated library or by using online generator tools to specify parameters like frequency, interval, and end dates.
    serverId String
    Server ID for the backup schedule.

    Supporting Types

    ServerBackupScheduleBackupProperties, ServerBackupScheduleBackupPropertiesArgs

    Name string
    RetentionPeriod int
    VolumeIds List<string>
    Name string
    RetentionPeriod int
    VolumeIds []string
    name String
    retentionPeriod Integer
    volumeIds List<String>
    name string
    retentionPeriod number
    volumeIds string[]
    name str
    retention_period int
    volume_ids Sequence[str]
    name String
    retentionPeriod Number
    volumeIds List<String>

    Package Details

    Repository
    stackit stackitcloud/pulumi-stackit
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the stackit Terraform Provider.
    stackit logo
    Viewing docs for stackit v0.0.4
    published on Friday, Feb 20, 2026 by stackitcloud
      Try Pulumi Cloud free. Your team will thank you.