Scaleway v1.27.0 published on Monday, Apr 21, 2025 by pulumiverse
scaleway.instance.getSnapshot
Explore with Pulumi AI
Gets information about an instance snapshot.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scaleway from "@pulumi/scaleway";
// Get info by snapshot name
const byName = scaleway.instance.getSnapshot({
    name: "my-snapshot-name",
});
// Get info by snapshot ID
const byId = scaleway.instance.getSnapshot({
    snapshotId: "11111111-1111-1111-1111-111111111111",
});
import pulumi
import pulumi_scaleway as scaleway
# Get info by snapshot name
by_name = scaleway.instance.get_snapshot(name="my-snapshot-name")
# Get info by snapshot ID
by_id = scaleway.instance.get_snapshot(snapshot_id="11111111-1111-1111-1111-111111111111")
package main
import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/instance"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get info by snapshot name
		_, err := instance.LookupSnapshot(ctx, &instance.LookupSnapshotArgs{
			Name: pulumi.StringRef("my-snapshot-name"),
		}, nil)
		if err != nil {
			return err
		}
		// Get info by snapshot ID
		_, err = instance.LookupSnapshot(ctx, &instance.LookupSnapshotArgs{
			SnapshotId: pulumi.StringRef("11111111-1111-1111-1111-111111111111"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumi.Scaleway;
return await Deployment.RunAsync(() => 
{
    // Get info by snapshot name
    var byName = Scaleway.Instance.GetSnapshot.Invoke(new()
    {
        Name = "my-snapshot-name",
    });
    // Get info by snapshot ID
    var byId = Scaleway.Instance.GetSnapshot.Invoke(new()
    {
        SnapshotId = "11111111-1111-1111-1111-111111111111",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.instance.InstanceFunctions;
import com.pulumi.scaleway.instance.inputs.GetSnapshotArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        // Get info by snapshot name
        final var byName = InstanceFunctions.getSnapshot(GetSnapshotArgs.builder()
            .name("my-snapshot-name")
            .build());
        // Get info by snapshot ID
        final var byId = InstanceFunctions.getSnapshot(GetSnapshotArgs.builder()
            .snapshotId("11111111-1111-1111-1111-111111111111")
            .build());
    }
}
variables:
  # Get info by snapshot name
  byName:
    fn::invoke:
      function: scaleway:instance:getSnapshot
      arguments:
        name: my-snapshot-name
  # Get info by snapshot ID
  byId:
    fn::invoke:
      function: scaleway:instance:getSnapshot
      arguments:
        snapshotId: 11111111-1111-1111-1111-111111111111
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?: InvokeOptions): Output<GetSnapshotResult>def get_snapshot(name: Optional[str] = None,
                 project_id: Optional[str] = None,
                 snapshot_id: Optional[str] = None,
                 zone: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
def get_snapshot_output(name: Optional[pulumi.Input[str]] = None,
                 project_id: Optional[pulumi.Input[str]] = None,
                 snapshot_id: Optional[pulumi.Input[str]] = None,
                 zone: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = 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 CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
fn::invoke:
  function: scaleway:instance/getSnapshot:getSnapshot
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Name string
 - The snapshot name.
Only one of 
nameandsnapshot_idshould be specified. - Project
Id string project_id) The ID of the project the snapshot is associated with.- Snapshot
Id string - The snapshot id.
Only one of 
nameandsnapshot_idshould be specified. - Zone string
 zone) The zone in which the snapshot exists.
- Name string
 - The snapshot name.
Only one of 
nameandsnapshot_idshould be specified. - Project
Id string project_id) The ID of the project the snapshot is associated with.- Snapshot
Id string - The snapshot id.
Only one of 
nameandsnapshot_idshould be specified. - Zone string
 zone) The zone in which the snapshot exists.
- name String
 - The snapshot name.
Only one of 
nameandsnapshot_idshould be specified. - project
Id String project_id) The ID of the project the snapshot is associated with.- snapshot
Id String - The snapshot id.
Only one of 
nameandsnapshot_idshould be specified. - zone String
 zone) The zone in which the snapshot exists.
- name string
 - The snapshot name.
Only one of 
nameandsnapshot_idshould be specified. - project
Id string project_id) The ID of the project the snapshot is associated with.- snapshot
Id string - The snapshot id.
Only one of 
nameandsnapshot_idshould be specified. - zone string
 zone) The zone in which the snapshot exists.
- name str
 - The snapshot name.
Only one of 
nameandsnapshot_idshould be specified. - project_
id str project_id) The ID of the project the snapshot is associated with.- snapshot_
id str - The snapshot id.
Only one of 
nameandsnapshot_idshould be specified. - zone str
 zone) The zone in which the snapshot exists.
- name String
 - The snapshot name.
Only one of 
nameandsnapshot_idshould be specified. - project
Id String project_id) The ID of the project the snapshot is associated with.- snapshot
Id String - The snapshot id.
Only one of 
nameandsnapshot_idshould be specified. - zone String
 zone) The zone in which the snapshot exists.
getSnapshot Result
The following output properties are available:
- Created
At string - Id string
 - The provider-assigned unique ID for this managed resource.
 - Imports
List<Pulumiverse.
Scaleway. Instance. Outputs. Get Snapshot Import>  - Organization
Id string - Size
In intGb  - List<string>
 - Type string
 - Volume
Id string - Name string
 - Project
Id string - Snapshot
Id string - Zone string
 
- Created
At string - Id string
 - The provider-assigned unique ID for this managed resource.
 - Imports
[]Get
Snapshot Import  - Organization
Id string - Size
In intGb  - []string
 - Type string
 - Volume
Id string - Name string
 - Project
Id string - Snapshot
Id string - Zone string
 
- created
At String - id String
 - The provider-assigned unique ID for this managed resource.
 - imports
List<Get
Snapshot Import>  - organization
Id String - size
In IntegerGb  - List<String>
 - type String
 - volume
Id String - name String
 - project
Id String - snapshot
Id String - zone String
 
- created
At string - id string
 - The provider-assigned unique ID for this managed resource.
 - imports
Get
Snapshot Import[]  - organization
Id string - size
In numberGb  - string[]
 - type string
 - volume
Id string - name string
 - project
Id string - snapshot
Id string - zone string
 
- created_
at str - id str
 - The provider-assigned unique ID for this managed resource.
 - imports
Sequence[Get
Snapshot Import]  - organization_
id str - size_
in_ intgb  - Sequence[str]
 - type str
 - volume_
id str - name str
 - project_
id str - snapshot_
id str - zone str
 
- created
At String - id String
 - The provider-assigned unique ID for this managed resource.
 - imports List<Property Map>
 - organization
Id String - size
In NumberGb  - List<String>
 - type String
 - volume
Id String - name String
 - project
Id String - snapshot
Id String - zone String
 
Supporting Types
GetSnapshotImport  
Package Details
- Repository
 - scaleway pulumiverse/pulumi-scaleway
 - License
 - Apache-2.0
 - Notes
 - This Pulumi package is based on the 
scalewayTerraform Provider.