OpenStack v4.1.3, Aug 21 24

OpenStack v4.1.3 published on Wednesday, Aug 21, 2024 by Pulumi

openstack.blockstorage.getVolumeV3

Explore with Pulumi AI

OpenStack v4.1.3 published on Wednesday, Aug 21, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";

const volume1 = openstack.blockstorage.getVolumeV3({
    name: "volume_1",
});

import pulumi
import pulumi_openstack as openstack

volume1 = openstack.blockstorage.get_volume_v3(name="volume_1")

package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v4/go/openstack/blockstorage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := blockstorage.GetVolumeV3(ctx, &blockstorage.GetVolumeV3Args{
			Name: pulumi.StringRef("volume_1"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var volume1 = OpenStack.BlockStorage.GetVolumeV3.Invoke(new()
    {
        Name = "volume_1",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.blockstorage.BlockstorageFunctions;
import com.pulumi.openstack.blockstorage.inputs.GetVolumeV3Args;
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) {
        final var volume1 = BlockstorageFunctions.getVolumeV3(GetVolumeV3Args.builder()
            .name("volume_1")
            .build());

    }
}

variables:
  volume1:
    fn::invoke:
      Function: openstack:blockstorage:getVolumeV3
      Arguments:
        name: volume_1

Using getVolumeV3

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 getVolumeV3(args: GetVolumeV3Args, opts?: InvokeOptions): Promise<GetVolumeV3Result>
function getVolumeV3Output(args: GetVolumeV3OutputArgs, opts?: InvokeOptions): Output<GetVolumeV3Result>

def get_volume_v3(bootable: Optional[str] = None,
                  host: Optional[str] = None,
                  metadata: Optional[Mapping[str, str]] = None,
                  name: Optional[str] = None,
                  region: Optional[str] = None,
                  status: Optional[str] = None,
                  volume_type: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetVolumeV3Result
def get_volume_v3_output(bootable: Optional[pulumi.Input[str]] = None,
                  host: Optional[pulumi.Input[str]] = None,
                  metadata: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  region: Optional[pulumi.Input[str]] = None,
                  status: Optional[pulumi.Input[str]] = None,
                  volume_type: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetVolumeV3Result]

func GetVolumeV3(ctx *Context, args *GetVolumeV3Args, opts ...InvokeOption) (*GetVolumeV3Result, error)
func GetVolumeV3Output(ctx *Context, args *GetVolumeV3OutputArgs, opts ...InvokeOption) GetVolumeV3ResultOutput

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

public static class GetVolumeV3 
{
    public static Task<GetVolumeV3Result> InvokeAsync(GetVolumeV3Args args, InvokeOptions? opts = null)
    public static Output<GetVolumeV3Result> Invoke(GetVolumeV3InvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVolumeV3Result> getVolumeV3(GetVolumeV3Args args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: openstack:blockstorage/getVolumeV3:getVolumeV3
  arguments:
    # arguments dictionary

The following arguments are supported:

Bootable string: Indicates if the volume is bootable.
Host string: The OpenStack host on which the volume is located.
Metadata Dictionary<string, string>: Metadata key/value pairs associated with the volume.
Name string: The name of the volume.
Region string: The region in which to obtain the V3 Block Storage client. If omitted, the region argument of the provider is used.
Status string: The status of the volume.
VolumeType string: The type of the volume.

Bootable string: Indicates if the volume is bootable.
Host string: The OpenStack host on which the volume is located.
Metadata map[string]string: Metadata key/value pairs associated with the volume.
Name string: The name of the volume.
Region string: The region in which to obtain the V3 Block Storage client. If omitted, the region argument of the provider is used.
Status string: The status of the volume.
VolumeType string: The type of the volume.

bootable String: Indicates if the volume is bootable.
host String: The OpenStack host on which the volume is located.
metadata Map<String,String>: Metadata key/value pairs associated with the volume.
name String: The name of the volume.
region String: The region in which to obtain the V3 Block Storage client. If omitted, the region argument of the provider is used.
status String: The status of the volume.
volumeType String: The type of the volume.

bootable string: Indicates if the volume is bootable.
host string: The OpenStack host on which the volume is located.
metadata {[key: string]: string}: Metadata key/value pairs associated with the volume.
name string: The name of the volume.
region string: The region in which to obtain the V3 Block Storage client. If omitted, the region argument of the provider is used.
status string: The status of the volume.
volumeType string: The type of the volume.

bootable str: Indicates if the volume is bootable.
host str: The OpenStack host on which the volume is located.
metadata Mapping[str, str]: Metadata key/value pairs associated with the volume.
name str: The name of the volume.
region str: The region in which to obtain the V3 Block Storage client. If omitted, the region argument of the provider is used.
status str: The status of the volume.
volume_type str: The type of the volume.

bootable String: Indicates if the volume is bootable.
host String: The OpenStack host on which the volume is located.
metadata Map<String>: Metadata key/value pairs associated with the volume.
name String: The name of the volume.
region String: The region in which to obtain the V3 Block Storage client. If omitted, the region argument of the provider is used.
status String: The status of the volume.
volumeType String: The type of the volume.

getVolumeV3 Result

The following output properties are available:

Attachments List<Pulumi.OpenStack.BlockStorage.Outputs.GetVolumeV3Attachment>: If a volume is attached to an instance, this attribute will display the Attachment ID, Instance ID, and the Device as the Instance sees it.
Bootable string: Indicates if the volume is bootable.
Host string: The OpenStack host on which the volume is located.
Id string: The provider-assigned unique ID for this managed resource.
Metadata Dictionary<string, string>: See Argument Reference above.
Name string: See Argument Reference above.
Region string: See Argument Reference above.
Size int: The size of the volume in GBs.
SourceVolumeId string: The ID of the volume from which the current volume was created.
Status string: See Argument Reference above.
VolumeType string: The type of the volume.

Attachments []GetVolumeV3Attachment: If a volume is attached to an instance, this attribute will display the Attachment ID, Instance ID, and the Device as the Instance sees it.
Bootable string: Indicates if the volume is bootable.
Host string: The OpenStack host on which the volume is located.
Id string: The provider-assigned unique ID for this managed resource.
Metadata map[string]string: See Argument Reference above.
Name string: See Argument Reference above.
Region string: See Argument Reference above.
Size int: The size of the volume in GBs.
SourceVolumeId string: The ID of the volume from which the current volume was created.
Status string: See Argument Reference above.
VolumeType string: The type of the volume.

attachments List<GetVolumeV3Attachment>: If a volume is attached to an instance, this attribute will display the Attachment ID, Instance ID, and the Device as the Instance sees it.
bootable String: Indicates if the volume is bootable.
host String: The OpenStack host on which the volume is located.
id String: The provider-assigned unique ID for this managed resource.
metadata Map<String,String>: See Argument Reference above.
name String: See Argument Reference above.
region String: See Argument Reference above.
size Integer: The size of the volume in GBs.
sourceVolumeId String: The ID of the volume from which the current volume was created.
status String: See Argument Reference above.
volumeType String: The type of the volume.

attachments GetVolumeV3Attachment[]: If a volume is attached to an instance, this attribute will display the Attachment ID, Instance ID, and the Device as the Instance sees it.
bootable string: Indicates if the volume is bootable.
host string: The OpenStack host on which the volume is located.
id string: The provider-assigned unique ID for this managed resource.
metadata {[key: string]: string}: See Argument Reference above.
name string: See Argument Reference above.
region string: See Argument Reference above.
size number: The size of the volume in GBs.
sourceVolumeId string: The ID of the volume from which the current volume was created.
status string: See Argument Reference above.
volumeType string: The type of the volume.

attachments Sequence[GetVolumeV3Attachment]: If a volume is attached to an instance, this attribute will display the Attachment ID, Instance ID, and the Device as the Instance sees it.
bootable str: Indicates if the volume is bootable.
host str: The OpenStack host on which the volume is located.
id str: The provider-assigned unique ID for this managed resource.
metadata Mapping[str, str]: See Argument Reference above.
name str: See Argument Reference above.
region str: See Argument Reference above.
size int: The size of the volume in GBs.
source_volume_id str: The ID of the volume from which the current volume was created.
status str: See Argument Reference above.
volume_type str: The type of the volume.

attachments List<Property Map>: If a volume is attached to an instance, this attribute will display the Attachment ID, Instance ID, and the Device as the Instance sees it.
bootable String: Indicates if the volume is bootable.
host String: The OpenStack host on which the volume is located.
id String: The provider-assigned unique ID for this managed resource.
metadata Map<String>: See Argument Reference above.
name String: See Argument Reference above.
region String: See Argument Reference above.
size Number: The size of the volume in GBs.
sourceVolumeId String: The ID of the volume from which the current volume was created.
status String: See Argument Reference above.
volumeType String: The type of the volume.

Supporting Types

GetVolumeV3Attachment

Device string
Id string
InstanceId string

Device string
Id string
InstanceId string

device String
id String
instanceId String

device string
id string
instanceId string

device str
id str
instance_id str

device String
id String
instanceId String

Package Details

Repository: OpenStack pulumi/pulumi-openstack
License: Apache-2.0
Notes: This Pulumi package is based on the openstack Terraform Provider.

OpenStack v4.1.3 published on Wednesday, Aug 21, 2024 by Pulumi

pulumi/pulumi-openstack

openstack.blockstorage.getVolumeV3

On this page

On this page

Example Usage

Using getVolumeV3

getVolumeV3 Result

Supporting Types

GetVolumeV3Attachment

Package Details

On this page

On this page