Fork me on GitHub

Module blockstorage

@pulumi/openstack > blockstorage

Index

blockstorage/volume.ts blockstorage/volumeAttach.ts blockstorage/volumeAttachV2.ts blockstorage/volumeV1.ts blockstorage/volumeV2.ts

class Volume

Manages a V3 volume resource within OpenStack.

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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<{ ... }[]>;

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<{ ... }>;

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).

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.

class VolumeAttach

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_volume_attach_v3 resource for that.

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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<{ ... }>;

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 host_name 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.

class VolumeAttachV2

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_volume_attach_v2 resource for that.

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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<{ ... }>;

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 host_name 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.

class VolumeV1

Manages a V1 volume resource within OpenStack.

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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<{ ... }[]>;

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<{ ... }>;

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.

class VolumeV2

Manages a V2 volume resource within OpenStack.

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): 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

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. 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<{ ... }[]>;

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<{ ... }>;

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 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.

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<{ ... }>;

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).

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

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 host_name 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>;

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 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

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<{ ... }>;

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 host_name 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>;

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 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

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 host_name 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>;

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 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

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<{ ... }>;

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 host_name 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>;

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 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

Input properties used for looking up and filtering Volume resources.

property attachments

attachments?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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<{ ... }>;

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).

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

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<{ ... }>;

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

Input properties used for looking up and filtering VolumeV1 resources.

property attachments

attachments?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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<{ ... }>;

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

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<{ ... }>;

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 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

Input properties used for looking up and filtering VolumeV2 resources.

property attachments

attachments?: pulumi.Input<pulumi.Input<{ ... }>[]>;

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<{ ... }>;

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 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.