← All packages

OpenStack

Pulumi Official

Package maintained by Pulumi

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

Source code

VolumeAttach

Import

It is not possible to import this resource.

Create a VolumeAttach Resource

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

@overload
def VolumeAttach(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 attach_mode: Optional[str] = None,
                 device: Optional[str] = None,
                 host_name: Optional[str] = None,
                 initiator: Optional[str] = None,
                 ip_address: Optional[str] = None,
                 multipath: Optional[bool] = None,
                 os_type: Optional[str] = None,
                 platform: Optional[str] = None,
                 region: Optional[str] = None,
                 volume_id: Optional[str] = None,
                 wwnn: Optional[str] = None,
                 wwpns: Optional[Sequence[str]] = None)
@overload
def VolumeAttach(resource_name: str,
                 args: VolumeAttachArgs,
                 opts: Optional[ResourceOptions] = None)

func NewVolumeAttach(ctx *Context, name string, args VolumeAttachArgs, opts ...ResourceOption) (*VolumeAttach, error)

public VolumeAttach(string name, VolumeAttachArgs args, CustomResourceOptions? opts = null)

public VolumeAttach(String name, VolumeAttachArgs args)
public VolumeAttach(String name, VolumeAttachArgs args, CustomResourceOptions options)

type: openstack:blockstorage:VolumeAttach
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VolumeAttachArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args VolumeAttachArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VolumeAttachArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VolumeAttachArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args VolumeAttachArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

VolumeAttach Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The VolumeAttach resource accepts the following input properties:

HostName string: The host to attach the volume to.
VolumeId string: The ID of the Volume to attach to an Instance.
AttachMode 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.
Device 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.
Initiator string: The iSCSI initiator string to make the connection.
IpAddress string: The IP address of the host_name above.
Multipath bool: Whether to connect to this volume via multipath.
OsType string: The iSCSI initiator OS type.
Platform string: The iSCSI initiator platform.
Region 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.
Wwnn string: A wwnn name. Used for Fibre Channel connections.
Wwpns List<string>: An array of wwpn strings. Used for Fibre Channel connections.

HostName string: The host to attach the volume to.
VolumeId string: The ID of the Volume to attach to an Instance.
AttachMode 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.
Device 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.
Initiator string: The iSCSI initiator string to make the connection.
IpAddress string: The IP address of the host_name above.
Multipath bool: Whether to connect to this volume via multipath.
OsType string: The iSCSI initiator OS type.
Platform string: The iSCSI initiator platform.
Region 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.
Wwnn string: A wwnn name. Used for Fibre Channel connections.
Wwpns []string: An array of wwpn strings. Used for Fibre Channel connections.

hostName String: The host to attach the volume to.
volumeId String: The ID of the Volume to attach to an Instance.
attachMode 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.
device 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.
initiator String: The iSCSI initiator string to make the connection.
ipAddress String: The IP address of the host_name above.
multipath Boolean: Whether to connect to this volume via multipath.
osType String: The iSCSI initiator OS type.
platform String: The iSCSI initiator platform.
region 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.
wwnn String: A wwnn name. Used for Fibre Channel connections.
wwpns List<String>: An array of wwpn strings. Used for Fibre Channel connections.

hostName string: The host to attach the volume to.
volumeId string: The ID of the Volume to attach to an Instance.
attachMode 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.
device 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.
initiator string: The iSCSI initiator string to make the connection.
ipAddress string: The IP address of the host_name above.
multipath boolean: Whether to connect to this volume via multipath.
osType string: The iSCSI initiator OS type.
platform string: The iSCSI initiator platform.
region 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.
wwnn string: A wwnn name. Used for Fibre Channel connections.
wwpns string[]: An array of wwpn strings. Used for Fibre Channel connections.

host_name str: The host to attach the volume to.
volume_id str: The ID of the Volume to attach to an Instance.
attach_mode str: 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.
device str: 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.
initiator str: The iSCSI initiator string to make the connection.
ip_address str: The IP address of the host_name above.
multipath bool: Whether to connect to this volume via multipath.
os_type str: The iSCSI initiator OS type.
platform str: The iSCSI initiator platform.
region str: 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.
wwnn str: A wwnn name. Used for Fibre Channel connections.
wwpns Sequence[str]: An array of wwpn strings. Used for Fibre Channel connections.

hostName String: The host to attach the volume to.
volumeId String: The ID of the Volume to attach to an Instance.
attachMode 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.
device 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.
initiator String: The iSCSI initiator string to make the connection.
ipAddress String: The IP address of the host_name above.
multipath Boolean: Whether to connect to this volume via multipath.
osType String: The iSCSI initiator OS type.
platform String: The iSCSI initiator platform.
region 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.
wwnn String: A wwnn name. Used for Fibre Channel connections.
wwpns List<String>: An array of wwpn strings. Used for Fibre Channel connections.

Outputs

All input properties are implicitly available as output properties. Additionally, the VolumeAttach resource produces the following output properties:

Data Dictionary<string, object>: 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.
DriverVolumeType string: The storage driver that the volume is based on.
Id string: The provider-assigned unique ID for this managed resource.
MountPointBase string: A mount point base name for shared storage.

Data map[string]interface{}: 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.
DriverVolumeType string: The storage driver that the volume is based on.
Id string: The provider-assigned unique ID for this managed resource.
MountPointBase string: A mount point base name for shared storage.

data Map<String,Object>: 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.
driverVolumeType String: The storage driver that the volume is based on.
id String: The provider-assigned unique ID for this managed resource.
mountPointBase String: A mount point base name for shared storage.

data {[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.
driverVolumeType string: The storage driver that the volume is based on.
id string: The provider-assigned unique ID for this managed resource.
mountPointBase string: A mount point base name for shared storage.

data Mapping[str, 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.
driver_volume_type str: The storage driver that the volume is based on.
id str: The provider-assigned unique ID for this managed resource.
mount_point_base str: A mount point base name for shared storage.

data Map<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.
driverVolumeType String: The storage driver that the volume is based on.
id String: The provider-assigned unique ID for this managed resource.
mountPointBase String: A mount point base name for shared storage.

Look up an Existing VolumeAttach Resource

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attach_mode: Optional[str] = None,
        data: Optional[Mapping[str, Any]] = None,
        device: Optional[str] = None,
        driver_volume_type: Optional[str] = None,
        host_name: Optional[str] = None,
        initiator: Optional[str] = None,
        ip_address: Optional[str] = None,
        mount_point_base: Optional[str] = None,
        multipath: Optional[bool] = None,
        os_type: Optional[str] = None,
        platform: Optional[str] = None,
        region: Optional[str] = None,
        volume_id: Optional[str] = None,
        wwnn: Optional[str] = None,
        wwpns: Optional[Sequence[str]] = None) -> VolumeAttach

func GetVolumeAttach(ctx *Context, name string, id IDInput, state *VolumeAttachState, opts ...ResourceOption) (*VolumeAttach, error)

public static VolumeAttach Get(string name, Input<string> id, VolumeAttachState? state, CustomResourceOptions? opts = null)

public static VolumeAttach get(String name, Output<String> id, VolumeAttachState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AttachMode 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.
Data Dictionary<string, object>: 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.
Device 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.
DriverVolumeType string: The storage driver that the volume is based on.
HostName string: The host to attach the volume to.
Initiator string: The iSCSI initiator string to make the connection.
IpAddress string: The IP address of the host_name above.
MountPointBase string: A mount point base name for shared storage.
Multipath bool: Whether to connect to this volume via multipath.
OsType string: The iSCSI initiator OS type.
Platform string: The iSCSI initiator platform.
Region 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.
VolumeId string: The ID of the Volume to attach to an Instance.
Wwnn string: A wwnn name. Used for Fibre Channel connections.
Wwpns List<string>: An array of wwpn strings. Used for Fibre Channel connections.

AttachMode 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.
Data map[string]interface{}: 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.
Device 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.
DriverVolumeType string: The storage driver that the volume is based on.
HostName string: The host to attach the volume to.
Initiator string: The iSCSI initiator string to make the connection.
IpAddress string: The IP address of the host_name above.
MountPointBase string: A mount point base name for shared storage.
Multipath bool: Whether to connect to this volume via multipath.
OsType string: The iSCSI initiator OS type.
Platform string: The iSCSI initiator platform.
Region 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.
VolumeId string: The ID of the Volume to attach to an Instance.
Wwnn string: A wwnn name. Used for Fibre Channel connections.
Wwpns []string: An array of wwpn strings. Used for Fibre Channel connections.

attachMode 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.
data Map<String,Object>: 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.
device 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.
driverVolumeType String: The storage driver that the volume is based on.
hostName String: The host to attach the volume to.
initiator String: The iSCSI initiator string to make the connection.
ipAddress String: The IP address of the host_name above.
mountPointBase String: A mount point base name for shared storage.
multipath Boolean: Whether to connect to this volume via multipath.
osType String: The iSCSI initiator OS type.
platform String: The iSCSI initiator platform.
region 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.
volumeId String: The ID of the Volume to attach to an Instance.
wwnn String: A wwnn name. Used for Fibre Channel connections.
wwpns List<String>: An array of wwpn strings. Used for Fibre Channel connections.

attachMode 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.
data {[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.
device 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.
driverVolumeType string: The storage driver that the volume is based on.
hostName string: The host to attach the volume to.
initiator string: The iSCSI initiator string to make the connection.
ipAddress string: The IP address of the host_name above.
mountPointBase string: A mount point base name for shared storage.
multipath boolean: Whether to connect to this volume via multipath.
osType string: The iSCSI initiator OS type.
platform string: The iSCSI initiator platform.
region 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.
volumeId string: The ID of the Volume to attach to an Instance.
wwnn string: A wwnn name. Used for Fibre Channel connections.
wwpns string[]: An array of wwpn strings. Used for Fibre Channel connections.

attach_mode str: 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.
data Mapping[str, 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.
device str: 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.
driver_volume_type str: The storage driver that the volume is based on.
host_name str: The host to attach the volume to.
initiator str: The iSCSI initiator string to make the connection.
ip_address str: The IP address of the host_name above.
mount_point_base str: A mount point base name for shared storage.
multipath bool: Whether to connect to this volume via multipath.
os_type str: The iSCSI initiator OS type.
platform str: The iSCSI initiator platform.
region str: 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.
volume_id str: The ID of the Volume to attach to an Instance.
wwnn str: A wwnn name. Used for Fibre Channel connections.
wwpns Sequence[str]: An array of wwpn strings. Used for Fibre Channel connections.

attachMode 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.
data Map<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.
device 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.
driverVolumeType String: The storage driver that the volume is based on.
hostName String: The host to attach the volume to.
initiator String: The iSCSI initiator string to make the connection.
ipAddress String: The IP address of the host_name above.
mountPointBase String: A mount point base name for shared storage.
multipath Boolean: Whether to connect to this volume via multipath.
osType String: The iSCSI initiator OS type.
platform String: The iSCSI initiator platform.
region 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.
volumeId String: The ID of the Volume to attach to an Instance.
wwnn String: A wwnn name. Used for Fibre Channel connections.
wwpns List<String>: An array of wwpn strings. Used for Fibre Channel connections.

Package Details

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