Module blockstorage

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-openstack repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-openstack repo.

Functions

getAvailabilityZonesV3
getSnapshotV2
getSnapshotV3
getVolumeV2
getVolumeV3

Others

Resources

Resource QuoteSetV2

class QuoteSetV2 extends CustomResource

Manages a V2 block storage quotaset resource within OpenStack.

Note: This usually requires admin privileges.
Note: This resource has a no-op deletion so no actual actions will be done against the OpenStack API in case of delete call.

Example Usage

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

const project1 = new openstack.identity.Project("project1", {});
const quotaset1 = new openstack.blockstorage.QuoteSetV2("quotaset1", {
    projectId: project1.id,
    volumes: 10,
    snapshots: 4,
    gigabytes: 100,
    perVolumeGigabytes: 10,
    backups: 4,
    backupGigabytes: 10,
    groups: 100,
});

constructor

new QuoteSetV2(name: string, args: QuoteSetV2Args, opts?: pulumi.CustomResourceOptions)

Create a QuoteSetV2 resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QuoteSetV2State, opts?: pulumi.CustomResourceOptions): QuoteSetV2

Get an existing QuoteSetV2 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is QuoteSetV2

Returns true if the given object is an instance of QuoteSetV2. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backupGigabytes

public backupGigabytes: pulumi.Output<number>;

Quota value for backup gigabytes. Changing this updates the existing quotaset.

property backups

public backups: pulumi.Output<number>;

Quota value for backups. Changing this updates the existing quotaset.

property gigabytes

public gigabytes: pulumi.Output<number>;

Quota value for gigabytes. Changing this updates the existing quotaset.

property groups

public groups: pulumi.Output<number>;

Quota value for groups. Changing this updates the existing quotaset.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property perVolumeGigabytes

public perVolumeGigabytes: pulumi.Output<number>;

Quota value for gigabytes per volume . Changing this updates the existing quotaset.

property projectId

public projectId: pulumi.Output<string>;

ID of the project to manage quotas. Changing this creates a new quotaset.

property region

public region: pulumi.Output<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.

property snapshots

public snapshots: pulumi.Output<number>;

Quota value for snapshots. Changing this updates the existing quotaset.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumes

public volumes: pulumi.Output<number>;

Quota value for volumes. Changing this updates the existing quotaset.

Resource QuoteSetV3

class QuoteSetV3 extends CustomResource

Manages a V3 block storage quotaset resource within OpenStack.

Note: This usually requires admin privileges.
Note: This resource has a no-op deletion so no actual actions will be done against the OpenStack API in case of delete call.

Example Usage

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

const project1 = new openstack.identity.Project("project1", {});
const quotaset1 = new openstack.blockstorage.QuoteSetV3("quotaset1", {
    projectId: project1.id,
    volumes: 10,
    snapshots: 4,
    gigabytes: 100,
    perVolumeGigabytes: 10,
    backups: 4,
    backupGigabytes: 10,
    groups: 100,
});

constructor

new QuoteSetV3(name: string, args: QuoteSetV3Args, opts?: pulumi.CustomResourceOptions)

Create a QuoteSetV3 resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: QuoteSetV3State, opts?: pulumi.CustomResourceOptions): QuoteSetV3

Get an existing QuoteSetV3 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is QuoteSetV3

Returns true if the given object is an instance of QuoteSetV3. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property backupGigabytes

public backupGigabytes: pulumi.Output<number>;

Quota value for backup gigabytes. Changing this updates the existing quotaset.

property backups

public backups: pulumi.Output<number>;

Quota value for backups. Changing this updates the existing quotaset.

property gigabytes

public gigabytes: pulumi.Output<number>;

Quota value for gigabytes. Changing this updates the existing quotaset.

property groups

public groups: pulumi.Output<number>;

Quota value for groups. Changing this updates the existing quotaset.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property perVolumeGigabytes

public perVolumeGigabytes: pulumi.Output<number>;

Quota value for gigabytes per volume . Changing this updates the existing quotaset.

property projectId

public projectId: pulumi.Output<string>;

ID of the project to manage quotas. Changing this creates a new quotaset.

property region

public region: pulumi.Output<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.

property snapshots

public snapshots: pulumi.Output<number>;

Quota value for snapshots. Changing this updates the existing quotaset.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumes

public volumes: pulumi.Output<number>;

Quota value for volumes. Changing this updates the existing quotaset.

Resource Volume

class Volume extends CustomResource

Manages a V3 volume resource within OpenStack.

Example Usage

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

const volume1 = new openstack.blockstorage.Volume("volume1", {
    description: "first test volume",
    region: "RegionOne",
    size: 3,
});

constructor

new Volume(name: string, args: VolumeArgs, opts?: pulumi.CustomResourceOptions)

Create a Volume resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VolumeState, opts?: pulumi.CustomResourceOptions): Volume

Get an existing Volume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Volume

Returns true if the given object is an instance of Volume. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property attachments

public attachments: pulumi.Output<VolumeAttachment[]>;

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.

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The availability zone for the volume. Changing this creates a new volume.

property consistencyGroupId

public consistencyGroupId: pulumi.Output<string | undefined>;

The consistency group to place the volume in.

property description

public description: pulumi.Output<string | undefined>;

A description of the volume. Changing this updates the volume’s description.

property enableOnlineResize

public enableOnlineResize: pulumi.Output<boolean | undefined>;

When this option is set it allows extending attached volumes. Note: updating size of an attached volume requires Cinder support for version 3.42 and a compatible storage driver.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property imageId

public imageId: pulumi.Output<string | undefined>;

The image ID from which to create the volume. Changing this creates a new volume.

property metadata

public metadata: pulumi.Output<{[key: string]: any}>;

Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.

property multiattach

public multiattach: pulumi.Output<boolean | undefined>;

Allow the volume to be attached to more than one Compute instance.

property name

public name: pulumi.Output<string>;

A unique name for the volume. Changing this updates the volume’s name.

property region

public region: pulumi.Output<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.

property schedulerHints

public schedulerHints: pulumi.Output<VolumeSchedulerHint[] | undefined>;

Provide the Cinder scheduler with hints on where to instantiate a volume in the OpenStack cloud. The available hints are described below.

property size

public size: pulumi.Output<number>;

The size of the volume to create (in gigabytes).

property snapshotId

public snapshotId: pulumi.Output<string | undefined>;

The snapshot ID from which to create the volume. Changing this creates a new volume.

property sourceVolId

public sourceVolId: pulumi.Output<string | undefined>;

The volume ID from which to create the volume. Changing this creates a new volume.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumeType

public volumeType: pulumi.Output<string>;

The type of volume to create. Changing this creates a new volume.

Resource VolumeAttach

class VolumeAttach extends CustomResource

This resource is experimental and may be removed in the future! Feedback is requested if you find this resource useful or if you find any problems with it.

Creates a general purpose attachment connection to a Block Storage volume using the OpenStack Block Storage (Cinder) v3 API. Depending on your Block Storage service configuration, this resource can assist in attaching a volume to a non-OpenStack resource such as a bare-metal server or a remote virtual machine in a different cloud provider.

This does not actually attach a volume to an instance. Please use the openstack.compute.VolumeAttach resource for that.

Example Usage

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

const volume1 = new openstack.blockstorage.Volume("volume1", {
    size: 1,
});
const va1 = new openstack.blockstorage.VolumeAttach("va1", {
    device: "auto",
    hostName: "devstack",
    initiator: "iqn.1993-08.org.debian:01:e9861fb1859",
    ipAddress: "192.168.255.10",
    osType: "linux2",
    platform: "x8664",
    volumeId: volume1.id,
});

constructor

new VolumeAttach(name: string, args: VolumeAttachArgs, opts?: pulumi.CustomResourceOptions)

Create a VolumeAttach resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VolumeAttachState, opts?: pulumi.CustomResourceOptions): VolumeAttach

Get an existing VolumeAttach resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VolumeAttach

Returns true if the given object is an instance of VolumeAttach. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property attachMode

public attachMode: pulumi.Output<string | undefined>;

Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.

property data

public data: pulumi.Output<{[key: string]: any}>;

This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.

property device

public device: pulumi.Output<string | undefined>;

The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.

property driverVolumeType

public driverVolumeType: pulumi.Output<string>;

The storage driver that the volume is based on.

property hostName

public hostName: pulumi.Output<string>;

The host to attach the volume to.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property initiator

public initiator: pulumi.Output<string | undefined>;

The iSCSI initiator string to make the connection.

property ipAddress

public ipAddress: pulumi.Output<string | undefined>;

The IP address of the hostName above.

property mountPointBase

public mountPointBase: pulumi.Output<string>;

A mount point base name for shared storage.

property multipath

public multipath: pulumi.Output<boolean | undefined>;

Whether to connect to this volume via multipath.

property osType

public osType: pulumi.Output<string | undefined>;

The iSCSI initiator OS type.

property platform

public platform: pulumi.Output<string | undefined>;

The iSCSI initiator platform.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V3 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumeId

public volumeId: pulumi.Output<string>;

The ID of the Volume to attach to an Instance.

property wwnn

public wwnn: pulumi.Output<string | undefined>;

A wwnn name. Used for Fibre Channel connections.

property wwpns

public wwpns: pulumi.Output<string[] | undefined>;

An array of wwpn strings. Used for Fibre Channel connections.

Resource VolumeAttachV2

class VolumeAttachV2 extends CustomResource

This resource is experimental and may be removed in the future! Feedback is requested if you find this resource useful or if you find any problems with it.

Creates a general purpose attachment connection to a Block Storage volume using the OpenStack Block Storage (Cinder) v2 API. Depending on your Block Storage service configuration, this resource can assist in attaching a volume to a non-OpenStack resource such as a bare-metal server or a remote virtual machine in a different cloud provider.

This does not actually attach a volume to an instance. Please use the openstack.compute.VolumeAttach resource for that.

Example Usage

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

const volume1 = new openstack.blockstorage.VolumeV2("volume1", {
    size: 1,
});
const va1 = new openstack.blockstorage.VolumeAttachV2("va1", {
    device: "auto",
    hostName: "devstack",
    initiator: "iqn.1993-08.org.debian:01:e9861fb1859",
    ipAddress: "192.168.255.10",
    osType: "linux2",
    platform: "x8664",
    volumeId: volume1.id,
});

constructor

new VolumeAttachV2(name: string, args: VolumeAttachV2Args, opts?: pulumi.CustomResourceOptions)

Create a VolumeAttachV2 resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VolumeAttachV2State, opts?: pulumi.CustomResourceOptions): VolumeAttachV2

Get an existing VolumeAttachV2 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VolumeAttachV2

Returns true if the given object is an instance of VolumeAttachV2. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property attachMode

public attachMode: pulumi.Output<string | undefined>;

Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.

property data

public data: pulumi.Output<{[key: string]: any}>;

This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.

property device

public device: pulumi.Output<string | undefined>;

The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.

property driverVolumeType

public driverVolumeType: pulumi.Output<string>;

The storage driver that the volume is based on.

property hostName

public hostName: pulumi.Output<string>;

The host to attach the volume to.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property initiator

public initiator: pulumi.Output<string | undefined>;

The iSCSI initiator string to make the connection.

property ipAddress

public ipAddress: pulumi.Output<string | undefined>;

The IP address of the hostName above.

property mountPointBase

public mountPointBase: pulumi.Output<string>;

A mount point base name for shared storage.

property multipath

public multipath: pulumi.Output<boolean | undefined>;

Whether to connect to this volume via multipath.

property osType

public osType: pulumi.Output<string | undefined>;

The iSCSI initiator OS type.

property platform

public platform: pulumi.Output<string | undefined>;

The iSCSI initiator platform.

property region

public region: pulumi.Output<string>;

The region in which to obtain the V2 Block Storage client. A Block Storage client is needed to create a volume attachment. If omitted, the region argument of the provider is used. Changing this creates a new volume attachment.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumeId

public volumeId: pulumi.Output<string>;

The ID of the Volume to attach to an Instance.

property wwnn

public wwnn: pulumi.Output<string | undefined>;

A wwnn name. Used for Fibre Channel connections.

property wwpns

public wwpns: pulumi.Output<string[] | undefined>;

An array of wwpn strings. Used for Fibre Channel connections.

Resource VolumeV1

class VolumeV1 extends CustomResource

Manages a V1 volume resource within OpenStack.

Example Usage

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

const volume1 = new openstack.blockstorage.VolumeV1("volume1", {
    description: "first test volume",
    region: "RegionOne",
    size: 3,
});

constructor

new VolumeV1(name: string, args: VolumeV1Args, opts?: pulumi.CustomResourceOptions)

Create a VolumeV1 resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VolumeV1State, opts?: pulumi.CustomResourceOptions): VolumeV1

Get an existing VolumeV1 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VolumeV1

Returns true if the given object is an instance of VolumeV1. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property attachments

public attachments: pulumi.Output<VolumeV1Attachment[]>;

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.

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The availability zone for the volume. Changing this creates a new volume.

property description

public description: pulumi.Output<string | undefined>;

A description of the volume. Changing this updates the volume’s description.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property imageId

public imageId: pulumi.Output<string | undefined>;

The image ID from which to create the volume. Changing this creates a new volume.

property metadata

public metadata: pulumi.Output<{[key: string]: any}>;

Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.

property name

public name: pulumi.Output<string>;

A unique name for the volume. Changing this updates the volume’s name.

property region

public region: pulumi.Output<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.

property size

public size: pulumi.Output<number>;

The size of the volume to create (in gigabytes). Changing this creates a new volume.

property snapshotId

public snapshotId: pulumi.Output<string | undefined>;

The snapshot ID from which to create the volume. Changing this creates a new volume.

property sourceVolId

public sourceVolId: pulumi.Output<string | undefined>;

The volume ID from which to create the volume. Changing this creates a new volume.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumeType

public volumeType: pulumi.Output<string>;

The type of volume to create. Changing this creates a new volume.

Resource VolumeV2

class VolumeV2 extends CustomResource

Manages a V2 volume resource within OpenStack.

Example Usage

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

const volume1 = new openstack.blockstorage.VolumeV2("volume1", {
    description: "first test volume",
    region: "RegionOne",
    size: 3,
});

constructor

new VolumeV2(name: string, args: VolumeV2Args, opts?: pulumi.CustomResourceOptions)

Create a VolumeV2 resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VolumeV2State, opts?: pulumi.CustomResourceOptions): VolumeV2

Get an existing VolumeV2 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is VolumeV2

Returns true if the given object is an instance of VolumeV2. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property attachments

public attachments: pulumi.Output<VolumeV2Attachment[]>;

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.

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The availability zone for the volume. Changing this creates a new volume.

property consistencyGroupId

public consistencyGroupId: pulumi.Output<string | undefined>;

The consistency group to place the volume in.

property description

public description: pulumi.Output<string | undefined>;

A description of the volume. Changing this updates the volume’s description.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property imageId

public imageId: pulumi.Output<string | undefined>;

The image ID from which to create the volume. Changing this creates a new volume.

property metadata

public metadata: pulumi.Output<{[key: string]: any}>;

Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.

property name

public name: pulumi.Output<string>;

A unique name for the volume. Changing this updates the volume’s name.

property region

public region: pulumi.Output<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.

property schedulerHints

public schedulerHints: pulumi.Output<VolumeV2SchedulerHint[] | undefined>;

Provide the Cinder scheduler with hints on where to instantiate a volume in the OpenStack cloud. The available hints are described below.

property size

public size: pulumi.Output<number>;

The size of the volume to create (in gigabytes). Changing this creates a new volume.

property snapshotId

public snapshotId: pulumi.Output<string | undefined>;

The snapshot ID from which to create the volume. Changing this creates a new volume.

property sourceReplica

public sourceReplica: pulumi.Output<string | undefined>;

The volume ID to replicate with.

property sourceVolId

public sourceVolId: pulumi.Output<string | undefined>;

The volume ID from which to create the volume. Changing this creates a new volume.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumeType

public volumeType: pulumi.Output<string>;

The type of volume to create. Changing this creates a new volume.

Functions

Function getAvailabilityZonesV3

getAvailabilityZonesV3(args?: GetAvailabilityZonesV3Args, opts?: pulumi.InvokeOptions): Promise<GetAvailabilityZonesV3Result>

Use this data source to get a list of Block Storage availability zones from OpenStack

Example Usage

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

const zones = pulumi.output(openstack.blockstorage.getAvailabilityZonesV3({ async: true }));

Function getSnapshotV2

getSnapshotV2(args?: GetSnapshotV2Args, opts?: pulumi.InvokeOptions): Promise<GetSnapshotV2Result>

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

Example Usage

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

const snapshot1 = pulumi.output(openstack.blockstorage.getSnapshotV2({
    mostRecent: true,
    name: "snapshot1",
}, { async: true }));

Function getSnapshotV3

getSnapshotV3(args?: GetSnapshotV3Args, opts?: pulumi.InvokeOptions): Promise<GetSnapshotV3Result>

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

Example Usage

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

const snapshot1 = pulumi.output(openstack.blockstorage.getSnapshotV3({
    mostRecent: true,
    name: "snapshot1",
}, { async: true }));

Function getVolumeV2

getVolumeV2(args?: GetVolumeV2Args, opts?: pulumi.InvokeOptions): Promise<GetVolumeV2Result>

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

Example Usage

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

const volume1 = pulumi.output(openstack.blockstorage.getVolumeV2({
    name: "volume1",
}, { async: true }));

Function getVolumeV3

getVolumeV3(args?: GetVolumeV3Args, opts?: pulumi.InvokeOptions): Promise<GetVolumeV3Result>

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

Example Usage

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

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

Others

interface GetAvailabilityZonesV3Args

interface GetAvailabilityZonesV3Args

A collection of arguments for invoking getAvailabilityZonesV3.

property region

region?: undefined | string;

The region in which to obtain the Block Storage client. If omitted, the region argument of the provider is used.

property state

state?: undefined | string;

The state of the availability zones to match. Can either be available or unavailable. Default is available.

interface GetAvailabilityZonesV3Result

interface GetAvailabilityZonesV3Result

A collection of values returned by getAvailabilityZonesV3.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property names

names: string[];

The names of the availability zones, ordered alphanumerically, that match the queried state.

property region

region: string;

See Argument Reference above.

property state

state?: undefined | string;

See Argument Reference above.

interface GetSnapshotV2Args

interface GetSnapshotV2Args

A collection of arguments for invoking getSnapshotV2.

property mostRecent

mostRecent?: undefined | false | true;

Pick the most recently created snapshot if there are multiple results.

property name

name?: undefined | string;

The name of the snapshot.

property region

region?: undefined | string;

The region in which to obtain the V2 Block Storage client. If omitted, the region argument of the provider is used.

property status

status?: undefined | string;

The status of the snapshot.

property volumeId

volumeId?: undefined | string;

The ID of the snapshot’s volume.

interface GetSnapshotV2Result

interface GetSnapshotV2Result

A collection of values returned by getSnapshotV2.

property description

description: string;

The snapshot’s description.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property metadata

metadata: {[key: string]: any};

The snapshot’s metadata.

property mostRecent

mostRecent?: undefined | false | true;

property name

name: string;

See Argument Reference above.

property region

region: string;

See Argument Reference above.

property size

size: number;

The size of the snapshot.

property status

status: string;

See Argument Reference above.

property volumeId

volumeId: string;

See Argument Reference above.

interface GetSnapshotV3Args

interface GetSnapshotV3Args

A collection of arguments for invoking getSnapshotV3.

property mostRecent

mostRecent?: undefined | false | true;

Pick the most recently created snapshot if there are multiple results.

property name

name?: undefined | string;

The name of the snapshot.

property region

region?: undefined | string;

The region in which to obtain the V3 Block Storage client. If omitted, the region argument of the provider is used.

property status

status?: undefined | string;

The status of the snapshot.

property volumeId

volumeId?: undefined | string;

The ID of the snapshot’s volume.

interface GetSnapshotV3Result

interface GetSnapshotV3Result

A collection of values returned by getSnapshotV3.

property description

description: string;

The snapshot’s description.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property metadata

metadata: {[key: string]: any};

The snapshot’s metadata.

property mostRecent

mostRecent?: undefined | false | true;

property name

name: string;

See Argument Reference above.

property region

region: string;

See Argument Reference above.

property size

size: number;

The size of the snapshot.

property status

status: string;

See Argument Reference above.

property volumeId

volumeId: string;

See Argument Reference above.

interface GetVolumeV2Args

interface GetVolumeV2Args

A collection of arguments for invoking getVolumeV2.

property bootable

bootable?: undefined | string;

Indicates if the volume is bootable.

property metadata

metadata?: undefined | {[key: string]: any};

Metadata key/value pairs associated with the volume.

property name

name?: undefined | string;

The name of the volume.

property region

region?: undefined | string;

The region in which to obtain the V2 Block Storage client. If omitted, the region argument of the provider is used.

property status

status?: undefined | string;

The status of the volume.

property volumeType

volumeType?: undefined | string;

The type of the volume.

interface GetVolumeV2Result

interface GetVolumeV2Result

A collection of values returned by getVolumeV2.

property bootable

bootable: string;

Indicates if the volume is bootable.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property metadata

metadata: {[key: string]: any};

See Argument Reference above.

property name

name: string;

See Argument Reference above.

property region

region: string;

See Argument Reference above.

property size

size: number;

The size of the volume in GBs.

property sourceVolumeId

sourceVolumeId: string;

The ID of the volume from which the current volume was created.

property status

status: string;

See Argument Reference above.

property volumeType

volumeType: string;

The type of the volume.

interface GetVolumeV3Args

interface GetVolumeV3Args

A collection of arguments for invoking getVolumeV3.

property bootable

bootable?: undefined | string;

Indicates if the volume is bootable.

property metadata

metadata?: undefined | {[key: string]: any};

Metadata key/value pairs associated with the volume.

property name

name?: undefined | string;

The name of the volume.

property region

region?: undefined | string;

The region in which to obtain the V3 Block Storage client. If omitted, the region argument of the provider is used.

property status

status?: undefined | string;

The status of the volume.

property volumeType

volumeType?: undefined | string;

The type of the volume.

interface GetVolumeV3Result

interface GetVolumeV3Result

A collection of values returned by getVolumeV3.

property bootable

bootable: string;

Indicates if the volume is bootable.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property metadata

metadata: {[key: string]: any};

See Argument Reference above.

property multiattach

multiattach: boolean;

Indicates if the volume can be attached to more then one server.

property name

name: string;

See Argument Reference above.

property region

region: string;

See Argument Reference above.

property size

size: number;

The size of the volume in GBs.

property sourceVolumeId

sourceVolumeId: string;

The ID of the volume from which the current volume was created.

property status

status: string;

See Argument Reference above.

property volumeType

volumeType: string;

The type of the volume.

interface QuoteSetV2Args

interface QuoteSetV2Args

The set of arguments for constructing a QuoteSetV2 resource.

property backupGigabytes

backupGigabytes?: pulumi.Input<number>;

Quota value for backup gigabytes. Changing this updates the existing quotaset.

property backups

backups?: pulumi.Input<number>;

Quota value for backups. Changing this updates the existing quotaset.

property gigabytes

gigabytes?: pulumi.Input<number>;

Quota value for gigabytes. Changing this updates the existing quotaset.

property groups

groups?: pulumi.Input<number>;

Quota value for groups. Changing this updates the existing quotaset.

property perVolumeGigabytes

perVolumeGigabytes?: pulumi.Input<number>;

Quota value for gigabytes per volume . Changing this updates the existing quotaset.

property projectId

projectId: pulumi.Input<string>;

ID of the project to manage quotas. Changing this creates a new quotaset.

property region

region?: pulumi.Input<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.

property snapshots

snapshots?: pulumi.Input<number>;

Quota value for snapshots. Changing this updates the existing quotaset.

property volumes

volumes?: pulumi.Input<number>;

Quota value for volumes. Changing this updates the existing quotaset.

interface QuoteSetV2State

interface QuoteSetV2State

Input properties used for looking up and filtering QuoteSetV2 resources.

property backupGigabytes

backupGigabytes?: pulumi.Input<number>;

Quota value for backup gigabytes. Changing this updates the existing quotaset.

property backups

backups?: pulumi.Input<number>;

Quota value for backups. Changing this updates the existing quotaset.

property gigabytes

gigabytes?: pulumi.Input<number>;

Quota value for gigabytes. Changing this updates the existing quotaset.

property groups

groups?: pulumi.Input<number>;

Quota value for groups. Changing this updates the existing quotaset.

property perVolumeGigabytes

perVolumeGigabytes?: pulumi.Input<number>;

Quota value for gigabytes per volume . Changing this updates the existing quotaset.

property projectId

projectId?: pulumi.Input<string>;

ID of the project to manage quotas. Changing this creates a new quotaset.

property region

region?: pulumi.Input<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.

property snapshots

snapshots?: pulumi.Input<number>;

Quota value for snapshots. Changing this updates the existing quotaset.

property volumes

volumes?: pulumi.Input<number>;

Quota value for volumes. Changing this updates the existing quotaset.

interface QuoteSetV3Args

interface QuoteSetV3Args

The set of arguments for constructing a QuoteSetV3 resource.

property backupGigabytes

backupGigabytes?: pulumi.Input<number>;

Quota value for backup gigabytes. Changing this updates the existing quotaset.

property backups

backups?: pulumi.Input<number>;

Quota value for backups. Changing this updates the existing quotaset.

property gigabytes

gigabytes?: pulumi.Input<number>;

Quota value for gigabytes. Changing this updates the existing quotaset.

property groups

groups?: pulumi.Input<number>;

Quota value for groups. Changing this updates the existing quotaset.

property perVolumeGigabytes

perVolumeGigabytes?: pulumi.Input<number>;

Quota value for gigabytes per volume . Changing this updates the existing quotaset.

property projectId

projectId: pulumi.Input<string>;

ID of the project to manage quotas. Changing this creates a new quotaset.

property region

region?: pulumi.Input<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.

property snapshots

snapshots?: pulumi.Input<number>;

Quota value for snapshots. Changing this updates the existing quotaset.

property volumes

volumes?: pulumi.Input<number>;

Quota value for volumes. Changing this updates the existing quotaset.

interface QuoteSetV3State

interface QuoteSetV3State

Input properties used for looking up and filtering QuoteSetV3 resources.

property backupGigabytes

backupGigabytes?: pulumi.Input<number>;

Quota value for backup gigabytes. Changing this updates the existing quotaset.

property backups

backups?: pulumi.Input<number>;

Quota value for backups. Changing this updates the existing quotaset.

property gigabytes

gigabytes?: pulumi.Input<number>;

Quota value for gigabytes. Changing this updates the existing quotaset.

property groups

groups?: pulumi.Input<number>;

Quota value for groups. Changing this updates the existing quotaset.

property perVolumeGigabytes

perVolumeGigabytes?: pulumi.Input<number>;

Quota value for gigabytes per volume . Changing this updates the existing quotaset.

property projectId

projectId?: pulumi.Input<string>;

ID of the project to manage quotas. Changing this creates a new quotaset.

property region

region?: pulumi.Input<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new quotaset.

property snapshots

snapshots?: pulumi.Input<number>;

Quota value for snapshots. Changing this updates the existing quotaset.

property volumes

volumes?: pulumi.Input<number>;

Quota value for volumes. Changing this updates the existing quotaset.

interface VolumeArgs

interface VolumeArgs

The set of arguments for constructing a Volume resource.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The availability zone for the volume. Changing this creates a new volume.

property consistencyGroupId

consistencyGroupId?: pulumi.Input<string>;

The consistency group to place the volume in.

property description

description?: pulumi.Input<string>;

A description of the volume. Changing this updates the volume’s description.

property enableOnlineResize

enableOnlineResize?: pulumi.Input<boolean>;

When this option is set it allows extending attached volumes. Note: updating size of an attached volume requires Cinder support for version 3.42 and a compatible storage driver.

property imageId

imageId?: pulumi.Input<string>;

The image ID from which to create the volume. Changing this creates a new volume.

property metadata

metadata?: pulumi.Input<{[key: string]: any}>;

Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.

property multiattach

multiattach?: pulumi.Input<boolean>;

Allow the volume to be attached to more than one Compute instance.

property name

name?: pulumi.Input<string>;

A unique name for the volume. Changing this updates the volume’s name.

property region

region?: pulumi.Input<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.

property schedulerHints

schedulerHints?: pulumi.Input<pulumi.Input<VolumeSchedulerHint>[]>;

Provide the Cinder scheduler with hints on where to instantiate a volume in the OpenStack cloud. The available hints are described below.

property size

size: pulumi.Input<number>;

The size of the volume to create (in gigabytes).

property snapshotId

snapshotId?: pulumi.Input<string>;

The snapshot ID from which to create the volume. Changing this creates a new volume.

property sourceReplica

sourceReplica?: pulumi.Input<string>;

The volume ID to replicate with.

property sourceVolId

sourceVolId?: pulumi.Input<string>;

The volume ID from which to create the volume. Changing this creates a new volume.

property volumeType

volumeType?: pulumi.Input<string>;

The type of volume to create. Changing this creates a new volume.

interface VolumeAttachArgs

interface VolumeAttachArgs

The set of arguments for constructing a VolumeAttach resource.

property attachMode

attachMode?: pulumi.Input<string>;

Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.

property device

device?: pulumi.Input<string>;

The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.

property hostName

hostName: pulumi.Input<string>;

The host to attach the volume to.

property initiator

initiator?: pulumi.Input<string>;

The iSCSI initiator string to make the connection.

property ipAddress

ipAddress?: pulumi.Input<string>;

The IP address of the hostName above.

property multipath

multipath?: pulumi.Input<boolean>;

Whether to connect to this volume via multipath.

property osType

osType?: pulumi.Input<string>;

The iSCSI initiator OS type.

property platform

platform?: pulumi.Input<string>;

The iSCSI initiator platform.

property region

region?: pulumi.Input<string>;

property volumeId

volumeId: pulumi.Input<string>;

The ID of the Volume to attach to an Instance.

property wwnn

wwnn?: pulumi.Input<string>;

A wwnn name. Used for Fibre Channel connections.

property wwpns

wwpns?: pulumi.Input<pulumi.Input<string>[]>;

An array of wwpn strings. Used for Fibre Channel connections.

interface VolumeAttachState

interface VolumeAttachState

Input properties used for looking up and filtering VolumeAttach resources.

property attachMode

attachMode?: pulumi.Input<string>;

Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.

property data

data?: pulumi.Input<{[key: string]: any}>;

This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.

property device

device?: pulumi.Input<string>;

The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.

property driverVolumeType

driverVolumeType?: pulumi.Input<string>;

The storage driver that the volume is based on.

property hostName

hostName?: pulumi.Input<string>;

The host to attach the volume to.

property initiator

initiator?: pulumi.Input<string>;

The iSCSI initiator string to make the connection.

property ipAddress

ipAddress?: pulumi.Input<string>;

The IP address of the hostName above.

property mountPointBase

mountPointBase?: pulumi.Input<string>;

A mount point base name for shared storage.

property multipath

multipath?: pulumi.Input<boolean>;

Whether to connect to this volume via multipath.

property osType

osType?: pulumi.Input<string>;

The iSCSI initiator OS type.

property platform

platform?: pulumi.Input<string>;

The iSCSI initiator platform.

property region

region?: pulumi.Input<string>;

property volumeId

volumeId?: pulumi.Input<string>;

The ID of the Volume to attach to an Instance.

property wwnn

wwnn?: pulumi.Input<string>;

A wwnn name. Used for Fibre Channel connections.

property wwpns

wwpns?: pulumi.Input<pulumi.Input<string>[]>;

An array of wwpn strings. Used for Fibre Channel connections.

interface VolumeAttachV2Args

interface VolumeAttachV2Args

The set of arguments for constructing a VolumeAttachV2 resource.

property attachMode

attachMode?: pulumi.Input<string>;

Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.

property device

device?: pulumi.Input<string>;

The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.

property hostName

hostName: pulumi.Input<string>;

The host to attach the volume to.

property initiator

initiator?: pulumi.Input<string>;

The iSCSI initiator string to make the connection.

property ipAddress

ipAddress?: pulumi.Input<string>;

The IP address of the hostName above.

property multipath

multipath?: pulumi.Input<boolean>;

Whether to connect to this volume via multipath.

property osType

osType?: pulumi.Input<string>;

The iSCSI initiator OS type.

property platform

platform?: pulumi.Input<string>;

The iSCSI initiator platform.

property region

region?: pulumi.Input<string>;

property volumeId

volumeId: pulumi.Input<string>;

The ID of the Volume to attach to an Instance.

property wwnn

wwnn?: pulumi.Input<string>;

A wwnn name. Used for Fibre Channel connections.

property wwpns

wwpns?: pulumi.Input<pulumi.Input<string>[]>;

An array of wwpn strings. Used for Fibre Channel connections.

interface VolumeAttachV2State

interface VolumeAttachV2State

Input properties used for looking up and filtering VolumeAttachV2 resources.

property attachMode

attachMode?: pulumi.Input<string>;

Specify whether to attach the volume as Read-Only (ro) or Read-Write (rw). Only values of ro and rw are accepted. If left unspecified, the Block Storage API will apply a default of rw.

property data

data?: pulumi.Input<{[key: string]: any}>;

This is a map of key/value pairs that contain the connection information. You will want to pass this information to a provisioner script to finalize the connection. See below for more information.

property device

device?: pulumi.Input<string>;

The device to tell the Block Storage service this volume will be attached as. This is purely for informational purposes. You can specify auto or a device such as /dev/vdc.

property driverVolumeType

driverVolumeType?: pulumi.Input<string>;

The storage driver that the volume is based on.

property hostName

hostName?: pulumi.Input<string>;

The host to attach the volume to.

property initiator

initiator?: pulumi.Input<string>;

The iSCSI initiator string to make the connection.

property ipAddress

ipAddress?: pulumi.Input<string>;

The IP address of the hostName above.

property mountPointBase

mountPointBase?: pulumi.Input<string>;

A mount point base name for shared storage.

property multipath

multipath?: pulumi.Input<boolean>;

Whether to connect to this volume via multipath.

property osType

osType?: pulumi.Input<string>;

The iSCSI initiator OS type.

property platform

platform?: pulumi.Input<string>;

The iSCSI initiator platform.

property region

region?: pulumi.Input<string>;

property volumeId

volumeId?: pulumi.Input<string>;

The ID of the Volume to attach to an Instance.

property wwnn

wwnn?: pulumi.Input<string>;

A wwnn name. Used for Fibre Channel connections.

property wwpns

wwpns?: pulumi.Input<pulumi.Input<string>[]>;

An array of wwpn strings. Used for Fibre Channel connections.

interface VolumeState

interface VolumeState

Input properties used for looking up and filtering Volume resources.

property attachments

attachments?: pulumi.Input<pulumi.Input<VolumeAttachment>[]>;

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.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The availability zone for the volume. Changing this creates a new volume.

property consistencyGroupId

consistencyGroupId?: pulumi.Input<string>;

The consistency group to place the volume in.

property description

description?: pulumi.Input<string>;

A description of the volume. Changing this updates the volume’s description.

property enableOnlineResize

enableOnlineResize?: pulumi.Input<boolean>;

When this option is set it allows extending attached volumes. Note: updating size of an attached volume requires Cinder support for version 3.42 and a compatible storage driver.

property imageId

imageId?: pulumi.Input<string>;

The image ID from which to create the volume. Changing this creates a new volume.

property metadata

metadata?: pulumi.Input<{[key: string]: any}>;

Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.

property multiattach

multiattach?: pulumi.Input<boolean>;

Allow the volume to be attached to more than one Compute instance.

property name

name?: pulumi.Input<string>;

A unique name for the volume. Changing this updates the volume’s name.

property region

region?: pulumi.Input<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.

property schedulerHints

schedulerHints?: pulumi.Input<pulumi.Input<VolumeSchedulerHint>[]>;

Provide the Cinder scheduler with hints on where to instantiate a volume in the OpenStack cloud. The available hints are described below.

property size

size?: pulumi.Input<number>;

The size of the volume to create (in gigabytes).

property snapshotId

snapshotId?: pulumi.Input<string>;

The snapshot ID from which to create the volume. Changing this creates a new volume.

property sourceReplica

sourceReplica?: pulumi.Input<string>;

The volume ID to replicate with.

property sourceVolId

sourceVolId?: pulumi.Input<string>;

The volume ID from which to create the volume. Changing this creates a new volume.

property volumeType

volumeType?: pulumi.Input<string>;

The type of volume to create. Changing this creates a new volume.

interface VolumeV1Args

interface VolumeV1Args

The set of arguments for constructing a VolumeV1 resource.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The availability zone for the volume. Changing this creates a new volume.

property description

description?: pulumi.Input<string>;

A description of the volume. Changing this updates the volume’s description.

property imageId

imageId?: pulumi.Input<string>;

The image ID from which to create the volume. Changing this creates a new volume.

property metadata

metadata?: pulumi.Input<{[key: string]: any}>;

Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.

property name

name?: pulumi.Input<string>;

A unique name for the volume. Changing this updates the volume’s name.

property region

region?: pulumi.Input<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.

property size

size: pulumi.Input<number>;

The size of the volume to create (in gigabytes). Changing this creates a new volume.

property snapshotId

snapshotId?: pulumi.Input<string>;

The snapshot ID from which to create the volume. Changing this creates a new volume.

property sourceVolId

sourceVolId?: pulumi.Input<string>;

The volume ID from which to create the volume. Changing this creates a new volume.

property volumeType

volumeType?: pulumi.Input<string>;

The type of volume to create. Changing this creates a new volume.

interface VolumeV1State

interface VolumeV1State

Input properties used for looking up and filtering VolumeV1 resources.

property attachments

attachments?: pulumi.Input<pulumi.Input<VolumeV1Attachment>[]>;

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.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The availability zone for the volume. Changing this creates a new volume.

property description

description?: pulumi.Input<string>;

A description of the volume. Changing this updates the volume’s description.

property imageId

imageId?: pulumi.Input<string>;

The image ID from which to create the volume. Changing this creates a new volume.

property metadata

metadata?: pulumi.Input<{[key: string]: any}>;

Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.

property name

name?: pulumi.Input<string>;

A unique name for the volume. Changing this updates the volume’s name.

property region

region?: pulumi.Input<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.

property size

size?: pulumi.Input<number>;

The size of the volume to create (in gigabytes). Changing this creates a new volume.

property snapshotId

snapshotId?: pulumi.Input<string>;

The snapshot ID from which to create the volume. Changing this creates a new volume.

property sourceVolId

sourceVolId?: pulumi.Input<string>;

The volume ID from which to create the volume. Changing this creates a new volume.

property volumeType

volumeType?: pulumi.Input<string>;

The type of volume to create. Changing this creates a new volume.

interface VolumeV2Args

interface VolumeV2Args

The set of arguments for constructing a VolumeV2 resource.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The availability zone for the volume. Changing this creates a new volume.

property consistencyGroupId

consistencyGroupId?: pulumi.Input<string>;

The consistency group to place the volume in.

property description

description?: pulumi.Input<string>;

A description of the volume. Changing this updates the volume’s description.

property imageId

imageId?: pulumi.Input<string>;

The image ID from which to create the volume. Changing this creates a new volume.

property metadata

metadata?: pulumi.Input<{[key: string]: any}>;

Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.

property name

name?: pulumi.Input<string>;

A unique name for the volume. Changing this updates the volume’s name.

property region

region?: pulumi.Input<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.

property schedulerHints

schedulerHints?: pulumi.Input<pulumi.Input<VolumeV2SchedulerHint>[]>;

Provide the Cinder scheduler with hints on where to instantiate a volume in the OpenStack cloud. The available hints are described below.

property size

size: pulumi.Input<number>;

The size of the volume to create (in gigabytes). Changing this creates a new volume.

property snapshotId

snapshotId?: pulumi.Input<string>;

The snapshot ID from which to create the volume. Changing this creates a new volume.

property sourceReplica

sourceReplica?: pulumi.Input<string>;

The volume ID to replicate with.

property sourceVolId

sourceVolId?: pulumi.Input<string>;

The volume ID from which to create the volume. Changing this creates a new volume.

property volumeType

volumeType?: pulumi.Input<string>;

The type of volume to create. Changing this creates a new volume.

interface VolumeV2State

interface VolumeV2State

Input properties used for looking up and filtering VolumeV2 resources.

property attachments

attachments?: pulumi.Input<pulumi.Input<VolumeV2Attachment>[]>;

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.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The availability zone for the volume. Changing this creates a new volume.

property consistencyGroupId

consistencyGroupId?: pulumi.Input<string>;

The consistency group to place the volume in.

property description

description?: pulumi.Input<string>;

A description of the volume. Changing this updates the volume’s description.

property imageId

imageId?: pulumi.Input<string>;

The image ID from which to create the volume. Changing this creates a new volume.

property metadata

metadata?: pulumi.Input<{[key: string]: any}>;

Metadata key/value pairs to associate with the volume. Changing this updates the existing volume metadata.

property name

name?: pulumi.Input<string>;

A unique name for the volume. Changing this updates the volume’s name.

property region

region?: pulumi.Input<string>;

The region in which to create the volume. If omitted, the region argument of the provider is used. Changing this creates a new volume.

property schedulerHints

schedulerHints?: pulumi.Input<pulumi.Input<VolumeV2SchedulerHint>[]>;

Provide the Cinder scheduler with hints on where to instantiate a volume in the OpenStack cloud. The available hints are described below.

property size

size?: pulumi.Input<number>;

The size of the volume to create (in gigabytes). Changing this creates a new volume.

property snapshotId

snapshotId?: pulumi.Input<string>;

The snapshot ID from which to create the volume. Changing this creates a new volume.

property sourceReplica

sourceReplica?: pulumi.Input<string>;

The volume ID to replicate with.

property sourceVolId

sourceVolId?: pulumi.Input<string>;

The volume ID from which to create the volume. Changing this creates a new volume.

property volumeType

volumeType?: pulumi.Input<string>;

The type of volume to create. Changing this creates a new volume.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module blockstorage

Resources

Functions

Others

Resources

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage