1. Registry
  2. Packages
  3. Scaleway
  4. API Docs
  5. block
  6. getSnapshot
Viewing docs for Scaleway v1.60.0
published on Saturday, Oct 24, 2026 by pulumiverse
scaleway logo
Viewing docs for Scaleway v1.60.0
published on Saturday, Oct 24, 2026 by pulumiverse

    The scaleway.block.Snapshot data source is used to retrieve information about a Block Storage volume snapshot.

    Refer to the Block Storage product documentation and API documentation for more information.

    Using getSnapshot

    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 getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
    function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOutputOptions): Output<GetSnapshotResult>
    def get_snapshot(name: Optional[str] = None,
                     project_id: Optional[str] = None,
                     snapshot_id: Optional[str] = None,
                     volume_id: Optional[str] = None,
                     zone: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
    def get_snapshot_output(name: pulumi.Input[Optional[str]] = None,
                     project_id: pulumi.Input[Optional[str]] = None,
                     snapshot_id: pulumi.Input[Optional[str]] = None,
                     volume_id: pulumi.Input[Optional[str]] = None,
                     zone: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetSnapshotResult]
    func LookupSnapshot(ctx *Context, args *LookupSnapshotArgs, opts ...InvokeOption) (*LookupSnapshotResult, error)
    func LookupSnapshotOutput(ctx *Context, args *LookupSnapshotOutputArgs, opts ...InvokeOption) LookupSnapshotResultOutput

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

    public static class GetSnapshot 
    {
        public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
        public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
    public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
    public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: scaleway:block/getSnapshot:getSnapshot
      arguments:
        # arguments dictionary
    data "scaleway_block_get_snapshot" "name" {
        # arguments
    }

    The following arguments are supported:

    Name string
    The name of the snapshot. Only one of name or snapshotId should be specified.
    ProjectId string
    The unique identifier of the Project to which the snapshot is associated.
    SnapshotId string
    The unique identifier of the snapshot. Only one of name and snapshotId should be specified.
    VolumeId string
    The unique identifier of the volume from which the snapshot was created.
    Zone string
    ) The zone in which the snapshot exists.
    Name string
    The name of the snapshot. Only one of name or snapshotId should be specified.
    ProjectId string
    The unique identifier of the Project to which the snapshot is associated.
    SnapshotId string
    The unique identifier of the snapshot. Only one of name and snapshotId should be specified.
    VolumeId string
    The unique identifier of the volume from which the snapshot was created.
    Zone string
    ) The zone in which the snapshot exists.
    name string
    The name of the snapshot. Only one of name or snapshotId should be specified.
    project_id string
    The unique identifier of the Project to which the snapshot is associated.
    snapshot_id string
    The unique identifier of the snapshot. Only one of name and snapshotId should be specified.
    volume_id string
    The unique identifier of the volume from which the snapshot was created.
    zone string
    ) The zone in which the snapshot exists.
    name String
    The name of the snapshot. Only one of name or snapshotId should be specified.
    projectId String
    The unique identifier of the Project to which the snapshot is associated.
    snapshotId String
    The unique identifier of the snapshot. Only one of name and snapshotId should be specified.
    volumeId String
    The unique identifier of the volume from which the snapshot was created.
    zone String
    ) The zone in which the snapshot exists.
    name string
    The name of the snapshot. Only one of name or snapshotId should be specified.
    projectId string
    The unique identifier of the Project to which the snapshot is associated.
    snapshotId string
    The unique identifier of the snapshot. Only one of name and snapshotId should be specified.
    volumeId string
    The unique identifier of the volume from which the snapshot was created.
    zone string
    ) The zone in which the snapshot exists.
    name str
    The name of the snapshot. Only one of name or snapshotId should be specified.
    project_id str
    The unique identifier of the Project to which the snapshot is associated.
    snapshot_id str
    The unique identifier of the snapshot. Only one of name and snapshotId should be specified.
    volume_id str
    The unique identifier of the volume from which the snapshot was created.
    zone str
    ) The zone in which the snapshot exists.
    name String
    The name of the snapshot. Only one of name or snapshotId should be specified.
    projectId String
    The unique identifier of the Project to which the snapshot is associated.
    snapshotId String
    The unique identifier of the snapshot. Only one of name and snapshotId should be specified.
    volumeId String
    The unique identifier of the volume from which the snapshot was created.
    zone String
    ) The zone in which the snapshot exists.

    getSnapshot Result

    The following output properties are available:

    Id string
    Name string
    ProjectId string
    Srn string
    Tags List<string>
    VolumeId string
    Zone string
    SnapshotId string
    Id string
    Name string
    ProjectId string
    Srn string
    Tags []string
    VolumeId string
    Zone string
    SnapshotId string
    id string
    name string
    project_id string
    srn string
    tags list(string)
    volume_id string
    zone string
    snapshot_id string
    id String
    name String
    projectId String
    srn String
    tags List<String>
    volumeId String
    zone String
    snapshotId String
    id string
    name string
    projectId string
    srn string
    tags string[]
    volumeId string
    zone string
    snapshotId string
    id str
    name str
    project_id str
    srn str
    tags Sequence[str]
    volume_id str
    zone str
    snapshot_id str
    id String
    name String
    projectId String
    srn String
    tags List<String>
    volumeId String
    zone String
    snapshotId String

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Viewing docs for Scaleway v1.60.0
    published on Saturday, Oct 24, 2026 by pulumiverse

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial