1. Packages
  2. Hcloud Provider
  3. API Docs
  4. getStorageBoxSnapshot
Hetzner Cloud v1.29.0 published on Saturday, Nov 29, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-hcloud

hcloud.getStorageBoxSnapshot

hcloud logo
Hetzner Cloud v1.29.0 published on Saturday, Nov 29, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-hcloud

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    configuration:
  storageBoxId:
    type: dynamic
variables:
  byId:
    fn::invoke:
      function: hcloud:getStorageBoxSnapshot
      arguments:
        storageBoxId: ${storageBoxId}
        id: 2
  byName:
    fn::invoke:
      function: hcloud:getStorageBoxSnapshot
      arguments:
        storageBoxId: ${storageBoxId}
        name: 2025-02-12T11-35-19
  byLabelSelector:
    fn::invoke:
      function: hcloud:getStorageBox
      arguments:
        storageBoxId: ${storageBoxId}
        withSelector: env=production

    Using getStorageBoxSnapshot

    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 getStorageBoxSnapshot(args: GetStorageBoxSnapshotArgs, opts?: InvokeOptions): Promise<GetStorageBoxSnapshotResult>
function getStorageBoxSnapshotOutput(args: GetStorageBoxSnapshotOutputArgs, opts?: InvokeOptions): Output<GetStorageBoxSnapshotResult>
    def get_storage_box_snapshot(id: Optional[int] = None,
                             name: Optional[str] = None,
                             storage_box_id: Optional[int] = None,
                             with_selector: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetStorageBoxSnapshotResult
def get_storage_box_snapshot_output(id: Optional[pulumi.Input[int]] = None,
                             name: Optional[pulumi.Input[str]] = None,
                             storage_box_id: Optional[pulumi.Input[int]] = None,
                             with_selector: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetStorageBoxSnapshotResult]
    func LookupStorageBoxSnapshot(ctx *Context, args *LookupStorageBoxSnapshotArgs, opts ...InvokeOption) (*LookupStorageBoxSnapshotResult, error)
func LookupStorageBoxSnapshotOutput(ctx *Context, args *LookupStorageBoxSnapshotOutputArgs, opts ...InvokeOption) LookupStorageBoxSnapshotResultOutput

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

    public static class GetStorageBoxSnapshot 
{
    public static Task<GetStorageBoxSnapshotResult> InvokeAsync(GetStorageBoxSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetStorageBoxSnapshotResult> Invoke(GetStorageBoxSnapshotInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStorageBoxSnapshotResult> getStorageBoxSnapshot(GetStorageBoxSnapshotArgs args, InvokeOptions options)
public static Output<GetStorageBoxSnapshotResult> getStorageBoxSnapshot(GetStorageBoxSnapshotArgs args, InvokeOptions options)

    fn::invoke:
  function: hcloud:index/getStorageBoxSnapshot:getStorageBoxSnapshot
  arguments:
    # arguments dictionary

    The following arguments are supported:

    StorageBoxId int
    ID of the Storage Box.
    Id int
    ID of the Storage Box Snapshot.
    Name string
    Name of the Storage Box Snapshot.
    WithSelector string
    Filter results using a Label Selector.
    StorageBoxId int
    ID of the Storage Box.
    Id int
    ID of the Storage Box Snapshot.
    Name string
    Name of the Storage Box Snapshot.
    WithSelector string
    Filter results using a Label Selector.
    storageBoxId Integer
    ID of the Storage Box.
    id Integer
    ID of the Storage Box Snapshot.
    name String
    Name of the Storage Box Snapshot.
    withSelector String
    Filter results using a Label Selector.
    storageBoxId number
    ID of the Storage Box.
    id number
    ID of the Storage Box Snapshot.
    name string
    Name of the Storage Box Snapshot.
    withSelector string
    Filter results using a Label Selector.
    storage_box_id int
    ID of the Storage Box.
    id int
    ID of the Storage Box Snapshot.
    name str
    Name of the Storage Box Snapshot.
    with_selector str
    Filter results using a Label Selector.
    storageBoxId Number
    ID of the Storage Box.
    id Number
    ID of the Storage Box Snapshot.
    name String
    Name of the Storage Box Snapshot.
    withSelector String
    Filter results using a Label Selector.

    getStorageBoxSnapshot Result

    The following output properties are available:

    Description string
    Description of the Storage Box Snapshot.
    Id int
    ID of the Storage Box Snapshot.
    IsAutomatic bool
    Whether the Storage Box Snapshot was created automatically.
    Labels Dictionary<string, string>
    User-defined labels (key-value pairs) for the resource.
    Name string
    Name of the Storage Box Snapshot.
    Stats Pulumi.HCloud.Outputs.GetStorageBoxSnapshotStats
    Statistics of the Storage Box Snapshot.
    StorageBoxId int
    ID of the Storage Box.
    WithSelector string
    Filter results using a Label Selector.
    Description string
    Description of the Storage Box Snapshot.
    Id int
    ID of the Storage Box Snapshot.
    IsAutomatic bool
    Whether the Storage Box Snapshot was created automatically.
    Labels map[string]string
    User-defined labels (key-value pairs) for the resource.
    Name string
    Name of the Storage Box Snapshot.
    Stats GetStorageBoxSnapshotStats
    Statistics of the Storage Box Snapshot.
    StorageBoxId int
    ID of the Storage Box.
    WithSelector string
    Filter results using a Label Selector.
    description String
    Description of the Storage Box Snapshot.
    id Integer
    ID of the Storage Box Snapshot.
    isAutomatic Boolean
    Whether the Storage Box Snapshot was created automatically.
    labels Map<String,String>
    User-defined labels (key-value pairs) for the resource.
    name String
    Name of the Storage Box Snapshot.
    stats GetStorageBoxSnapshotStats
    Statistics of the Storage Box Snapshot.
    storageBoxId Integer
    ID of the Storage Box.
    withSelector String
    Filter results using a Label Selector.
    description string
    Description of the Storage Box Snapshot.
    id number
    ID of the Storage Box Snapshot.
    isAutomatic boolean
    Whether the Storage Box Snapshot was created automatically.
    labels {[key: string]: string}
    User-defined labels (key-value pairs) for the resource.
    name string
    Name of the Storage Box Snapshot.
    stats GetStorageBoxSnapshotStats
    Statistics of the Storage Box Snapshot.
    storageBoxId number
    ID of the Storage Box.
    withSelector string
    Filter results using a Label Selector.
    description str
    Description of the Storage Box Snapshot.
    id int
    ID of the Storage Box Snapshot.
    is_automatic bool
    Whether the Storage Box Snapshot was created automatically.
    labels Mapping[str, str]
    User-defined labels (key-value pairs) for the resource.
    name str
    Name of the Storage Box Snapshot.
    stats GetStorageBoxSnapshotStats
    Statistics of the Storage Box Snapshot.
    storage_box_id int
    ID of the Storage Box.
    with_selector str
    Filter results using a Label Selector.
    description String
    Description of the Storage Box Snapshot.
    id Number
    ID of the Storage Box Snapshot.
    isAutomatic Boolean
    Whether the Storage Box Snapshot was created automatically.
    labels Map<String>
    User-defined labels (key-value pairs) for the resource.
    name String
    Name of the Storage Box Snapshot.
    stats Property Map
    Statistics of the Storage Box Snapshot.
    storageBoxId Number
    ID of the Storage Box.
    withSelector String
    Filter results using a Label Selector.

    Supporting Types

    GetStorageBoxSnapshotStats

    Size int
    Current storage requirements of the Snapshot in bytes.
    SizeFilesystem int
    Size of the compressed file system contained in the Snapshot in bytes.
    Size int
    Current storage requirements of the Snapshot in bytes.
    SizeFilesystem int
    Size of the compressed file system contained in the Snapshot in bytes.
    size Integer
    Current storage requirements of the Snapshot in bytes.
    sizeFilesystem Integer
    Size of the compressed file system contained in the Snapshot in bytes.
    size number
    Current storage requirements of the Snapshot in bytes.
    sizeFilesystem number
    Size of the compressed file system contained in the Snapshot in bytes.
    size int
    Current storage requirements of the Snapshot in bytes.
    size_filesystem int
    Size of the compressed file system contained in the Snapshot in bytes.
    size Number
    Current storage requirements of the Snapshot in bytes.
    sizeFilesystem Number
    Size of the compressed file system contained in the Snapshot in bytes.

    Package Details

    Repository
    Hetzner Cloud pulumi/pulumi-hcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the hcloud Terraform Provider.
    hcloud logo
    Hetzner Cloud v1.29.0 published on Saturday, Nov 29, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-hcloud
      Meet Neo: Your AI Platform Teammate