Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. stackit
  4. API Docs
  5. VolumeAutomation
Viewing docs for stackit v0.0.8
published on Friday, Oct 16, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

stackit.VolumeAutomation

stackit logo
Viewing docs for stackit v0.0.8
published on Friday, Oct 16, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

    Volume automation 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_volume_automation" "example" {
  project_id  = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  template_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  name        = "example-volume-automation"
  description = "Creates daily volume snapshots and keeps the last 7."
  input = jsonencode({
    kind                = "VolumeRecoveryPointManagement"
    inheritVolumeLabels = false
    recoveryPointLabels = {
      "exampleLabelKey1" = "exampleLabelValue1"
      "exampleLabelKey2" = "exampleLabelValue2"
    }
    snapshotRetentionPolicy = {
      kind  = "count"
      value = 2
    }
    volumeLabelSelector = "myLabelkey1=myLabelValue,myLabelKey2=myOtherLabelValue"
  })
  triggers = {
    schedule = {
      rrule = "DTSTART;TZID=Europe/Sofia:20200803T023000 RRULE:FREQ=DAILY;INTERVAL=1"
    }
  }
}

    Create VolumeAutomation Resource

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

    Constructor syntax

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

@overload
def VolumeAutomation(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     project_id: Optional[str] = None,
                     template_id: Optional[str] = None,
                     description: Optional[str] = None,
                     input: Optional[str] = None,
                     name: Optional[str] = None,
                     region: Optional[str] = None,
                     triggers: Optional[VolumeAutomationTriggersArgs] = None)
    func NewVolumeAutomation(ctx *Context, name string, args VolumeAutomationArgs, opts ...ResourceOption) (*VolumeAutomation, error)
    public VolumeAutomation(string name, VolumeAutomationArgs args, CustomResourceOptions? opts = null)
    public VolumeAutomation(String name, VolumeAutomationArgs args)
public VolumeAutomation(String name, VolumeAutomationArgs args, CustomResourceOptions options)

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


    resource "stackit_volume_automation" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args VolumeAutomationArgs
    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 VolumeAutomationArgs
    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 VolumeAutomationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VolumeAutomationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VolumeAutomationArgs
    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 volumeAutomationResource = new Stackit.VolumeAutomation("volumeAutomationResource", new()
{
    ProjectId = "string",
    TemplateId = "string",
    Description = "string",
    Input = "string",
    Name = "string",
    Region = "string",
    Triggers = new Stackit.Inputs.VolumeAutomationTriggersArgs
    {
        Schedule = new Stackit.Inputs.VolumeAutomationTriggersScheduleArgs
        {
            Rrule = "string",
        },
    },
});

    example, err := stackit.NewVolumeAutomation(ctx, "volumeAutomationResource", &stackit.VolumeAutomationArgs{
	ProjectId:   pulumi.String("string"),
	TemplateId:  pulumi.String("string"),
	Description: pulumi.String("string"),
	Input:       pulumi.String("string"),
	Name:        pulumi.String("string"),
	Region:      pulumi.String("string"),
	Triggers: &stackit.VolumeAutomationTriggersArgs{
		Schedule: &stackit.VolumeAutomationTriggersScheduleArgs{
			Rrule: pulumi.String("string"),
		},
	},
})

    resource "stackit_volume_automation" "volumeAutomationResource" {
  lifecycle {
    create_before_destroy = true
  }
  project_id  = "string"
  template_id = "string"
  description = "string"
  input       = "string"
  name        = "string"
  region      = "string"
  triggers = {
    schedule = {
      rrule = "string"
    }
  }
}

    var volumeAutomationResource = new VolumeAutomation("volumeAutomationResource", VolumeAutomationArgs.builder()
    .projectId("string")
    .templateId("string")
    .description("string")
    .input("string")
    .name("string")
    .region("string")
    .triggers(VolumeAutomationTriggersArgs.builder()
        .schedule(VolumeAutomationTriggersScheduleArgs.builder()
            .rrule("string")
            .build())
        .build())
    .build());

    volume_automation_resource = stackit.VolumeAutomation("volumeAutomationResource",
    project_id="string",
    template_id="string",
    description="string",
    input="string",
    name="string",
    region="string",
    triggers={
        "schedule": {
            "rrule": "string",
        },
    })

    const volumeAutomationResource = new stackit.VolumeAutomation("volumeAutomationResource", {
    projectId: "string",
    templateId: "string",
    description: "string",
    input: "string",
    name: "string",
    region: "string",
    triggers: {
        schedule: {
            rrule: "string",
        },
    },
});

    type: stackit:VolumeAutomation
properties:
    description: string
    input: string
    name: string
    projectId: string
    region: string
    templateId: string
    triggers:
        schedule:
            rrule: string

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

    ProjectId string
    STACKIT Project ID to which the volume automation is associated.
    TemplateId string
    ID of the automation template this volume automation is based on.
    Description string
    The volume automation description.
    Input string
    Configuration input for the volume automation. See API Docs for possible configuration options.
    Name string
    The volume automation name.
    Region string
    The resource region. If not defined, the provider region is used.
    Triggers VolumeAutomationTriggers
    Triggers that determine when the automation runs.
    ProjectId string
    STACKIT Project ID to which the volume automation is associated.
    TemplateId string
    ID of the automation template this volume automation is based on.
    Description string
    The volume automation description.
    Input string
    Configuration input for the volume automation. See API Docs for possible configuration options.
    Name string
    The volume automation name.
    Region string
    The resource region. If not defined, the provider region is used.
    Triggers VolumeAutomationTriggersArgs
    Triggers that determine when the automation runs.
    project_id string
    STACKIT Project ID to which the volume automation is associated.
    template_id string
    ID of the automation template this volume automation is based on.
    description string
    The volume automation description.
    input string
    Configuration input for the volume automation. See API Docs for possible configuration options.
    name string
    The volume automation name.
    region string
    The resource region. If not defined, the provider region is used.
    triggers object
    Triggers that determine when the automation runs.
    projectId String
    STACKIT Project ID to which the volume automation is associated.
    templateId String
    ID of the automation template this volume automation is based on.
    description String
    The volume automation description.
    input String
    Configuration input for the volume automation. See API Docs for possible configuration options.
    name String
    The volume automation name.
    region String
    The resource region. If not defined, the provider region is used.
    triggers VolumeAutomationTriggers
    Triggers that determine when the automation runs.
    projectId string
    STACKIT Project ID to which the volume automation is associated.
    templateId string
    ID of the automation template this volume automation is based on.
    description string
    The volume automation description.
    input string
    Configuration input for the volume automation. See API Docs for possible configuration options.
    name string
    The volume automation name.
    region string
    The resource region. If not defined, the provider region is used.
    triggers VolumeAutomationTriggers
    Triggers that determine when the automation runs.
    project_id str
    STACKIT Project ID to which the volume automation is associated.
    template_id str
    ID of the automation template this volume automation is based on.
    description str
    The volume automation description.
    input str
    Configuration input for the volume automation. See API Docs for possible configuration options.
    name str
    The volume automation name.
    region str
    The resource region. If not defined, the provider region is used.
    triggers VolumeAutomationTriggersArgs
    Triggers that determine when the automation runs.
    projectId String
    STACKIT Project ID to which the volume automation is associated.
    templateId String
    ID of the automation template this volume automation is based on.
    description String
    The volume automation description.
    input String
    Configuration input for the volume automation. See API Docs for possible configuration options.
    name String
    The volume automation name.
    region String
    The resource region. If not defined, the provider region is used.
    triggers Property Map
    Triggers that determine when the automation runs.

    Outputs

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

    AutomationId string
    ID of the volume automation.
    Id string
    The provider-assigned unique ID for this managed resource.
    AutomationId string
    ID of the volume automation.
    Id string
    The provider-assigned unique ID for this managed resource.
    automation_id string
    ID of the volume automation.
    id string
    The provider-assigned unique ID for this managed resource.
    automationId String
    ID of the volume automation.
    id String
    The provider-assigned unique ID for this managed resource.
    automationId string
    ID of the volume automation.
    id string
    The provider-assigned unique ID for this managed resource.
    automation_id str
    ID of the volume automation.
    id str
    The provider-assigned unique ID for this managed resource.
    automationId String
    ID of the volume automation.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VolumeAutomation Resource

    Get an existing VolumeAutomation 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?: VolumeAutomationState, opts?: CustomResourceOptions): VolumeAutomation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automation_id: Optional[str] = None,
        description: Optional[str] = None,
        input: Optional[str] = None,
        name: Optional[str] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        template_id: Optional[str] = None,
        triggers: Optional[VolumeAutomationTriggersArgs] = None) -> VolumeAutomation
    func GetVolumeAutomation(ctx *Context, name string, id IDInput, state *VolumeAutomationState, opts ...ResourceOption) (*VolumeAutomation, error)
    public static VolumeAutomation Get(string name, Input<string> id, VolumeAutomationState? state, CustomResourceOptions? opts = null)
    public static VolumeAutomation get(String name, Output<String> id, VolumeAutomationState state, CustomResourceOptions options)
    resources:  _:    type: stackit:VolumeAutomation    get:      id: ${id}
    import {
  to = stackit_volume_automation.example
  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:
    AutomationId string
    ID of the volume automation.
    Description string
    The volume automation description.
    Input string
    Configuration input for the volume automation. See API Docs for possible configuration options.
    Name string
    The volume automation name.
    ProjectId string
    STACKIT Project ID to which the volume automation is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    TemplateId string
    ID of the automation template this volume automation is based on.
    Triggers VolumeAutomationTriggers
    Triggers that determine when the automation runs.
    AutomationId string
    ID of the volume automation.
    Description string
    The volume automation description.
    Input string
    Configuration input for the volume automation. See API Docs for possible configuration options.
    Name string
    The volume automation name.
    ProjectId string
    STACKIT Project ID to which the volume automation is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    TemplateId string
    ID of the automation template this volume automation is based on.
    Triggers VolumeAutomationTriggersArgs
    Triggers that determine when the automation runs.
    automation_id string
    ID of the volume automation.
    description string
    The volume automation description.
    input string
    Configuration input for the volume automation. See API Docs for possible configuration options.
    name string
    The volume automation name.
    project_id string
    STACKIT Project ID to which the volume automation is associated.
    region string
    The resource region. If not defined, the provider region is used.
    template_id string
    ID of the automation template this volume automation is based on.
    triggers object
    Triggers that determine when the automation runs.
    automationId String
    ID of the volume automation.
    description String
    The volume automation description.
    input String
    Configuration input for the volume automation. See API Docs for possible configuration options.
    name String
    The volume automation name.
    projectId String
    STACKIT Project ID to which the volume automation is associated.
    region String
    The resource region. If not defined, the provider region is used.
    templateId String
    ID of the automation template this volume automation is based on.
    triggers VolumeAutomationTriggers
    Triggers that determine when the automation runs.
    automationId string
    ID of the volume automation.
    description string
    The volume automation description.
    input string
    Configuration input for the volume automation. See API Docs for possible configuration options.
    name string
    The volume automation name.
    projectId string
    STACKIT Project ID to which the volume automation is associated.
    region string
    The resource region. If not defined, the provider region is used.
    templateId string
    ID of the automation template this volume automation is based on.
    triggers VolumeAutomationTriggers
    Triggers that determine when the automation runs.
    automation_id str
    ID of the volume automation.
    description str
    The volume automation description.
    input str
    Configuration input for the volume automation. See API Docs for possible configuration options.
    name str
    The volume automation name.
    project_id str
    STACKIT Project ID to which the volume automation is associated.
    region str
    The resource region. If not defined, the provider region is used.
    template_id str
    ID of the automation template this volume automation is based on.
    triggers VolumeAutomationTriggersArgs
    Triggers that determine when the automation runs.
    automationId String
    ID of the volume automation.
    description String
    The volume automation description.
    input String
    Configuration input for the volume automation. See API Docs for possible configuration options.
    name String
    The volume automation name.
    projectId String
    STACKIT Project ID to which the volume automation is associated.
    region String
    The resource region. If not defined, the provider region is used.
    templateId String
    ID of the automation template this volume automation is based on.
    triggers Property Map
    Triggers that determine when the automation runs.

    Supporting Types

    VolumeAutomationTriggers, VolumeAutomationTriggersArgs

    Schedule VolumeAutomationTriggersSchedule
    Runs the automation on a recurring schedule.
    Schedule VolumeAutomationTriggersSchedule
    Runs the automation on a recurring schedule.
    schedule object
    Runs the automation on a recurring schedule.
    schedule VolumeAutomationTriggersSchedule
    Runs the automation on a recurring schedule.
    schedule VolumeAutomationTriggersSchedule
    Runs the automation on a recurring schedule.
    schedule VolumeAutomationTriggersSchedule
    Runs the automation on a recurring schedule.
    schedule Property Map
    Runs the automation on a recurring schedule.

    VolumeAutomationTriggersSchedule, VolumeAutomationTriggersScheduleArgs

    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.
    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.
    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.
    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.
    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.
    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.
    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.

    Import

    In Terraform v1.5.0 and later, the + "" + import + “" + block can be used with the + "” + id + “" + attribute, for example:

    # Only use the import statement, if you want to import an existing volume automation resource
import {
  to = stackit_volume_automation.import-example
  id = "${var.project_id},${var.region},${var.automation_id}"
}

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

    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.8
    published on Friday, Oct 16, 2026 by stackitcloud
    Schema (JSON)
    stackitcloud/pulumi-stackit

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial