@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
158 lines (157 loc) • 3.95 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Use this data source to get information about an existing volume.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const volume1 = openstack.blockstorage.getVolumeV3({
* name: "volume_1",
* });
* ```
*/
export declare function getVolumeV3(args?: GetVolumeV3Args, opts?: pulumi.InvokeOptions): Promise<GetVolumeV3Result>;
/**
* A collection of arguments for invoking getVolumeV3.
*/
export interface GetVolumeV3Args {
/**
* Indicates if the volume is bootable.
*/
bootable?: string;
/**
* The OpenStack host on which the volume is located.
*/
host?: string;
/**
* Metadata key/value pairs associated with the volume.
*/
metadata?: {
[key: string]: string;
};
/**
* The name of the volume.
*/
name?: string;
/**
* The region in which to obtain the V3 Block Storage
* client. If omitted, the `region` argument of the provider is used.
*/
region?: string;
/**
* The status of the volume.
*/
status?: string;
/**
* The type of the volume.
*/
volumeType?: string;
}
/**
* A collection of values returned by getVolumeV3.
*/
export interface GetVolumeV3Result {
/**
* 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.
*/
readonly attachments: outputs.blockstorage.GetVolumeV3Attachment[];
/**
* Indicates if the volume is bootable.
*/
readonly bootable: string;
/**
* The OpenStack host on which the volume is located.
*/
readonly host: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* See Argument Reference above.
*/
readonly metadata: {
[key: string]: string;
};
/**
* See Argument Reference above.
*/
readonly name: string;
/**
* See Argument Reference above.
*/
readonly region: string;
/**
* The size of the volume in GBs.
*/
readonly size: number;
/**
* The ID of the volume from which the current volume was created.
*/
readonly sourceVolumeId: string;
/**
* See Argument Reference above.
*/
readonly status: string;
/**
* The type of the volume.
*/
readonly volumeType: string;
}
/**
* Use this data source to get information about an existing volume.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const volume1 = openstack.blockstorage.getVolumeV3({
* name: "volume_1",
* });
* ```
*/
export declare function getVolumeV3Output(args?: GetVolumeV3OutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetVolumeV3Result>;
/**
* A collection of arguments for invoking getVolumeV3.
*/
export interface GetVolumeV3OutputArgs {
/**
* Indicates if the volume is bootable.
*/
bootable?: pulumi.Input<string>;
/**
* The OpenStack host on which the volume is located.
*/
host?: pulumi.Input<string>;
/**
* Metadata key/value pairs associated with the volume.
*/
metadata?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The name of the volume.
*/
name?: pulumi.Input<string>;
/**
* The region in which to obtain the V3 Block Storage
* client. If omitted, the `region` argument of the provider is used.
*/
region?: pulumi.Input<string>;
/**
* The status of the volume.
*/
status?: pulumi.Input<string>;
/**
* The type of the volume.
*/
volumeType?: pulumi.Input<string>;
}