← All packages

OpenStack

Pulumi Official

Package maintained by Pulumi

v3.8.0 published on Monday, Feb 7, 2022 by Pulumi

Source code

getVolumeV3

Use this data source to get information about an existing volume.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
    public MyStack()
    {
        var volume1 = Output.Create(OpenStack.BlockStorage.GetVolumeV3.InvokeAsync(new OpenStack.BlockStorage.GetVolumeV3Args
        {
            Name = "volume_1",
        }));
    }

}

package main

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

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

Coming soon!

import pulumi
import pulumi_openstack as openstack

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

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

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

Coming soon!

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, Any]] = 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, Any]]] = 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, object>: 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]interface{}: 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,Object>: 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]: any}: 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, Any]: 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<Any>: 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:

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, object>: See Argument Reference above.
Multiattach bool: Indicates if the volume can be attached to more then one server.
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.

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]interface{}: See Argument Reference above.
Multiattach bool: Indicates if the volume can be attached to more then one server.
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.

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,Object>: See Argument Reference above.
multiattach Boolean: Indicates if the volume can be attached to more then one server.
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.

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]: any}: See Argument Reference above.
multiattach boolean: Indicates if the volume can be attached to more then one server.
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.

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, Any]: See Argument Reference above.
multiattach bool: Indicates if the volume can be attached to more then one server.
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.

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<Any>: See Argument Reference above.
multiattach Boolean: Indicates if the volume can be attached to more then one server.
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.

Package Details

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