1. Packages
  2. Scaleway
  3. API Docs
  4. getBlockSnapshot
Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse

scaleway.getBlockSnapshot

Explore with Pulumi AI

scaleway logo
Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse

    The scaleway.BlockSnapshot 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 getBlockSnapshot

    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 getBlockSnapshot(args: GetBlockSnapshotArgs, opts?: InvokeOptions): Promise<GetBlockSnapshotResult>
    function getBlockSnapshotOutput(args: GetBlockSnapshotOutputArgs, opts?: InvokeOptions): Output<GetBlockSnapshotResult>
    def get_block_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) -> GetBlockSnapshotResult
    def get_block_snapshot_output(name: Optional[pulumi.Input[str]] = None,
                           project_id: Optional[pulumi.Input[str]] = None,
                           snapshot_id: Optional[pulumi.Input[str]] = None,
                           volume_id: Optional[pulumi.Input[str]] = None,
                           zone: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetBlockSnapshotResult]
    func LookupBlockSnapshot(ctx *Context, args *LookupBlockSnapshotArgs, opts ...InvokeOption) (*LookupBlockSnapshotResult, error)
    func LookupBlockSnapshotOutput(ctx *Context, args *LookupBlockSnapshotOutputArgs, opts ...InvokeOption) LookupBlockSnapshotResultOutput

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

    public static class GetBlockSnapshot 
    {
        public static Task<GetBlockSnapshotResult> InvokeAsync(GetBlockSnapshotArgs args, InvokeOptions? opts = null)
        public static Output<GetBlockSnapshotResult> Invoke(GetBlockSnapshotInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBlockSnapshotResult> getBlockSnapshot(GetBlockSnapshotArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: scaleway:index/getBlockSnapshot:getBlockSnapshot
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the snapshot. Only one of name or snapshot_id 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 snapshot_id 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 snapshot_id 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 snapshot_id 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 snapshot_id 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 snapshot_id 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 snapshot_id 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 snapshot_id 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 snapshot_id 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 snapshot_id 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 snapshot_id 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 snapshot_id 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.

    getBlockSnapshot Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Tags List<string>
    Name string
    ProjectId string
    SnapshotId string
    VolumeId string
    Zone string
    Id string
    The provider-assigned unique ID for this managed resource.
    Tags []string
    Name string
    ProjectId string
    SnapshotId string
    VolumeId string
    Zone string
    id String
    The provider-assigned unique ID for this managed resource.
    tags List<String>
    name String
    projectId String
    snapshotId String
    volumeId String
    zone String
    id string
    The provider-assigned unique ID for this managed resource.
    tags string[]
    name string
    projectId string
    snapshotId string
    volumeId string
    zone string
    id str
    The provider-assigned unique ID for this managed resource.
    tags Sequence[str]
    name str
    project_id str
    snapshot_id str
    volume_id str
    zone str
    id String
    The provider-assigned unique ID for this managed resource.
    tags List<String>
    name String
    projectId String
    snapshotId 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 logo
    Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse