Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. block
  5. getVolume
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.block.getVolume

Explore with Pulumi AI

Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

The scaleway.block.Volume data source is used to retrieve information about a Block Storage volume. Refer to the Block Storage product documentation and API documentation for more information.

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>
Copy
def get_volume(name: Optional[str] = None,
               project_id: Optional[str] = None,
               volume_id: Optional[str] = None,
               zone: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(name: Optional[pulumi.Input[str]] = None,
               project_id: Optional[pulumi.Input[str]] = None,
               volume_id: Optional[pulumi.Input[str]] = None,
               zone: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVolumeResult]
Copy
func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: scaleway:block/getVolume:getVolume
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

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

getVolume Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
InstanceVolumeId string
Iops int
SizeInGb int
SnapshotId string
Tags List<string>
Name string
ProjectId string
VolumeId string
Zone string
Id string
The provider-assigned unique ID for this managed resource.
InstanceVolumeId string
Iops int
SizeInGb int
SnapshotId string
Tags []string
Name string
ProjectId string
VolumeId string
Zone string
id String
The provider-assigned unique ID for this managed resource.
instanceVolumeId String
iops Integer
sizeInGb Integer
snapshotId String
tags List<String>
name String
projectId String
volumeId String
zone String
id string
The provider-assigned unique ID for this managed resource.
instanceVolumeId string
iops number
sizeInGb number
snapshotId string
tags string[]
name string
projectId string
volumeId string
zone string
id str
The provider-assigned unique ID for this managed resource.
instance_volume_id str
iops int
size_in_gb int
snapshot_id str
tags Sequence[str]
name str
project_id str
volume_id str
zone str
id String
The provider-assigned unique ID for this managed resource.
instanceVolumeId String
iops Number
sizeInGb Number
snapshotId String
tags List<String>
name String
projectId String
volumeId String
zone String

Package Details

Repository
scaleway pulumiverse/pulumi-scaleway
License
Apache-2.0
Notes
This Pulumi package is based on the scaleway Terraform Provider.
Scaleway v1.26.0 published on Friday, Mar 28, 2025 by pulumiverse
pulumiverse/pulumi-scaleway