1. Packages
  2. stackit
  3. API Docs
  4. getVolume
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

stackit.getVolume

stackit logo
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
Schema (JSON)
stackitcloud/pulumi-stackit

    Volume resource schema. Must have a region specified in the provider configuration.

    Example Usage

    data "stackit_volume" "example" {
  project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  volume_id  = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

    Using getVolume

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>
function getVolumeOutput(args: GetVolumeOutputArgs, opts?: InvokeOptions): Output<GetVolumeResult>
    def get_volume(project_id: Optional[str] = None,
               region: Optional[str] = None,
               volume_id: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(project_id: Optional[pulumi.Input[str]] = None,
               region: Optional[pulumi.Input[str]] = None,
               volume_id: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVolumeResult]
    func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput

    > Note: This function is named LookupVolume in the Go SDK.

    public static class GetVolume 
{
    public static Task<GetVolumeResult> InvokeAsync(GetVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeResult> Invoke(GetVolumeInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)

    fn::invoke:
  function: stackit:index/getVolume:getVolume
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ProjectId string
    STACKIT project ID to which the volume is associated.
    VolumeId string
    The volume ID.
    Region string
    The resource region. If not defined, the provider region is used.
    ProjectId string
    STACKIT project ID to which the volume is associated.
    VolumeId string
    The volume ID.
    Region string
    The resource region. If not defined, the provider region is used.
    projectId String
    STACKIT project ID to which the volume is associated.
    volumeId String
    The volume ID.
    region String
    The resource region. If not defined, the provider region is used.
    projectId string
    STACKIT project ID to which the volume is associated.
    volumeId string
    The volume ID.
    region string
    The resource region. If not defined, the provider region is used.
    project_id str
    STACKIT project ID to which the volume is associated.
    volume_id str
    The volume ID.
    region str
    The resource region. If not defined, the provider region is used.
    projectId String
    STACKIT project ID to which the volume is associated.
    volumeId String
    The volume ID.
    region String
    The resource region. If not defined, the provider region is used.

    getVolume Result

    The following output properties are available:

    AvailabilityZone string
    The availability zone of the volume.
    Description string
    The description of the volume.
    Encrypted bool
    Indicates if the volume is encrypted.
    Id string
    Labels Dictionary<string, string>
    Labels are key-value string pairs which can be attached to a resource container
    Name string
    The name of the volume.
    PerformanceClass string
    The performance class of the volume. Possible values are documented in Service plans BlockStorage
    ProjectId string
    STACKIT project ID to which the volume is associated.
    ServerId string
    The server ID of the server to which the volume is attached to.
    Size int
    The size of the volume in GB. It can only be updated to a larger value than the current size
    Source GetVolumeSource
    The source of the volume. It can be either a volume, an image, a snapshot or a backup
    VolumeId string
    The volume ID.
    Region string
    The resource region. If not defined, the provider region is used.
    AvailabilityZone string
    The availability zone of the volume.
    Description string
    The description of the volume.
    Encrypted bool
    Indicates if the volume is encrypted.
    Id string
    Labels map[string]string
    Labels are key-value string pairs which can be attached to a resource container
    Name string
    The name of the volume.
    PerformanceClass string
    The performance class of the volume. Possible values are documented in Service plans BlockStorage
    ProjectId string
    STACKIT project ID to which the volume is associated.
    ServerId string
    The server ID of the server to which the volume is attached to.
    Size int
    The size of the volume in GB. It can only be updated to a larger value than the current size
    Source GetVolumeSource
    The source of the volume. It can be either a volume, an image, a snapshot or a backup
    VolumeId string
    The volume ID.
    Region string
    The resource region. If not defined, the provider region is used.
    availabilityZone String
    The availability zone of the volume.
    description String
    The description of the volume.
    encrypted Boolean
    Indicates if the volume is encrypted.
    id String
    labels Map<String,String>
    Labels are key-value string pairs which can be attached to a resource container
    name String
    The name of the volume.
    performanceClass String
    The performance class of the volume. Possible values are documented in Service plans BlockStorage
    projectId String
    STACKIT project ID to which the volume is associated.
    serverId String
    The server ID of the server to which the volume is attached to.
    size Integer
    The size of the volume in GB. It can only be updated to a larger value than the current size
    source GetVolumeSource
    The source of the volume. It can be either a volume, an image, a snapshot or a backup
    volumeId String
    The volume ID.
    region String
    The resource region. If not defined, the provider region is used.
    availabilityZone string
    The availability zone of the volume.
    description string
    The description of the volume.
    encrypted boolean
    Indicates if the volume is encrypted.
    id string
    labels {[key: string]: string}
    Labels are key-value string pairs which can be attached to a resource container
    name string
    The name of the volume.
    performanceClass string
    The performance class of the volume. Possible values are documented in Service plans BlockStorage
    projectId string
    STACKIT project ID to which the volume is associated.
    serverId string
    The server ID of the server to which the volume is attached to.
    size number
    The size of the volume in GB. It can only be updated to a larger value than the current size
    source GetVolumeSource
    The source of the volume. It can be either a volume, an image, a snapshot or a backup
    volumeId string
    The volume ID.
    region string
    The resource region. If not defined, the provider region is used.
    availability_zone str
    The availability zone of the volume.
    description str
    The description of the volume.
    encrypted bool
    Indicates if the volume is encrypted.
    id str
    labels Mapping[str, str]
    Labels are key-value string pairs which can be attached to a resource container
    name str
    The name of the volume.
    performance_class str
    The performance class of the volume. Possible values are documented in Service plans BlockStorage
    project_id str
    STACKIT project ID to which the volume is associated.
    server_id str
    The server ID of the server to which the volume is attached to.
    size int
    The size of the volume in GB. It can only be updated to a larger value than the current size
    source GetVolumeSource
    The source of the volume. It can be either a volume, an image, a snapshot or a backup
    volume_id str
    The volume ID.
    region str
    The resource region. If not defined, the provider region is used.
    availabilityZone String
    The availability zone of the volume.
    description String
    The description of the volume.
    encrypted Boolean
    Indicates if the volume is encrypted.
    id String
    labels Map<String>
    Labels are key-value string pairs which can be attached to a resource container
    name String
    The name of the volume.
    performanceClass String
    The performance class of the volume. Possible values are documented in Service plans BlockStorage
    projectId String
    STACKIT project ID to which the volume is associated.
    serverId String
    The server ID of the server to which the volume is attached to.
    size Number
    The size of the volume in GB. It can only be updated to a larger value than the current size
    source Property Map
    The source of the volume. It can be either a volume, an image, a snapshot or a backup
    volumeId String
    The volume ID.
    region String
    The resource region. If not defined, the provider region is used.

    Supporting Types

    GetVolumeSource

    Id string
    The ID of the source, e.g. image ID
    Type string
    The type of the source. Possible values are: volume, image, snapshot, backup.
    Id string
    The ID of the source, e.g. image ID
    Type string
    The type of the source. Possible values are: volume, image, snapshot, backup.
    id String
    The ID of the source, e.g. image ID
    type String
    The type of the source. Possible values are: volume, image, snapshot, backup.
    id string
    The ID of the source, e.g. image ID
    type string
    The type of the source. Possible values are: volume, image, snapshot, backup.
    id str
    The ID of the source, e.g. image ID
    type str
    The type of the source. Possible values are: volume, image, snapshot, backup.
    id String
    The ID of the source, e.g. image ID
    type String
    The type of the source. Possible values are: volume, image, snapshot, backup.

    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
    Schema (JSON)
    stackitcloud/pulumi-stackit
      Try Pulumi Cloud free. Your team will thank you.