OpenStack
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:
- Host
Name string The host to attach the volume to.
- Volume
Id string The ID of the Volume to attach to an Instance.
- Attach
Mode string Specify whether to attach the volume as Read-Only (
ro
) or Read-Write (rw
). Only values ofro
andrw
are accepted. If left unspecified, the Block Storage API will apply a default ofrw
.- 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.
- Ip
Address string The IP address of the
host_name
above.- Multipath bool
Whether to connect to this volume via multipath.
- Os
Type 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.
- Host
Name string The host to attach the volume to.
- Volume
Id string The ID of the Volume to attach to an Instance.
- Attach
Mode string Specify whether to attach the volume as Read-Only (
ro
) or Read-Write (rw
). Only values ofro
andrw
are accepted. If left unspecified, the Block Storage API will apply a default ofrw
.- 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.
- Ip
Address string The IP address of the
host_name
above.- Multipath bool
Whether to connect to this volume via multipath.
- Os
Type 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 String The host to attach the volume to.
- volume
Id String The ID of the Volume to attach to an Instance.
- attach
Mode String Specify whether to attach the volume as Read-Only (
ro
) or Read-Write (rw
). Only values ofro
andrw
are accepted. If left unspecified, the Block Storage API will apply a default ofrw
.- 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.
- ip
Address String The IP address of the
host_name
above.- multipath Boolean
Whether to connect to this volume via multipath.
- os
Type 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.
- host
Name string The host to attach the volume to.
- volume
Id string The ID of the Volume to attach to an Instance.
- attach
Mode string Specify whether to attach the volume as Read-Only (
ro
) or Read-Write (rw
). Only values ofro
andrw
are accepted. If left unspecified, the Block Storage API will apply a default ofrw
.- 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.
- ip
Address string The IP address of the
host_name
above.- multipath boolean
Whether to connect to this volume via multipath.
- os
Type 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 ofro
andrw
are accepted. If left unspecified, the Block Storage API will apply a default ofrw
.- 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.
- host
Name String The host to attach the volume to.
- volume
Id String The ID of the Volume to attach to an Instance.
- attach
Mode String Specify whether to attach the volume as Read-Only (
ro
) or Read-Write (rw
). Only values ofro
andrw
are accepted. If left unspecified, the Block Storage API will apply a default ofrw
.- 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.
- ip
Address String The IP address of the
host_name
above.- multipath Boolean
Whether to connect to this volume via multipath.
- os
Type 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.
- Driver
Volume stringType The storage driver that the volume is based on.
- Id string
The provider-assigned unique ID for this managed resource.
- Mount
Point stringBase 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.
- Driver
Volume stringType The storage driver that the volume is based on.
- Id string
The provider-assigned unique ID for this managed resource.
- Mount
Point stringBase 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.
- driver
Volume StringType The storage driver that the volume is based on.
- id String
The provider-assigned unique ID for this managed resource.
- mount
Point StringBase 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.
- driver
Volume stringType The storage driver that the volume is based on.
- id string
The provider-assigned unique ID for this managed resource.
- mount
Point stringBase 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_ strtype The storage driver that the volume is based on.
- id str
The provider-assigned unique ID for this managed resource.
- mount_
point_ strbase 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.
- driver
Volume StringType The storage driver that the volume is based on.
- id String
The provider-assigned unique ID for this managed resource.
- mount
Point StringBase 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.
- Attach
Mode string Specify whether to attach the volume as Read-Only (
ro
) or Read-Write (rw
). Only values ofro
andrw
are accepted. If left unspecified, the Block Storage API will apply a default ofrw
.- 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
.- Driver
Volume stringType The storage driver that the volume is based on.
- Host
Name string The host to attach the volume to.
- Initiator string
The iSCSI initiator string to make the connection.
- Ip
Address string The IP address of the
host_name
above.- Mount
Point stringBase A mount point base name for shared storage.
- Multipath bool
Whether to connect to this volume via multipath.
- Os
Type 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.- Volume
Id 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.
- Attach
Mode string Specify whether to attach the volume as Read-Only (
ro
) or Read-Write (rw
). Only values ofro
andrw
are accepted. If left unspecified, the Block Storage API will apply a default ofrw
.- 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
.- Driver
Volume stringType The storage driver that the volume is based on.
- Host
Name string The host to attach the volume to.
- Initiator string
The iSCSI initiator string to make the connection.
- Ip
Address string The IP address of the
host_name
above.- Mount
Point stringBase A mount point base name for shared storage.
- Multipath bool
Whether to connect to this volume via multipath.
- Os
Type 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.- Volume
Id 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 String Specify whether to attach the volume as Read-Only (
ro
) or Read-Write (rw
). Only values ofro
andrw
are accepted. If left unspecified, the Block Storage API will apply a default ofrw
.- 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
.- driver
Volume StringType The storage driver that the volume is based on.
- host
Name String The host to attach the volume to.
- initiator String
The iSCSI initiator string to make the connection.
- ip
Address String The IP address of the
host_name
above.- mount
Point StringBase A mount point base name for shared storage.
- multipath Boolean
Whether to connect to this volume via multipath.
- os
Type 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.- volume
Id 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.
- attach
Mode string Specify whether to attach the volume as Read-Only (
ro
) or Read-Write (rw
). Only values ofro
andrw
are accepted. If left unspecified, the Block Storage API will apply a default ofrw
.- 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
.- driver
Volume stringType The storage driver that the volume is based on.
- host
Name string The host to attach the volume to.
- initiator string
The iSCSI initiator string to make the connection.
- ip
Address string The IP address of the
host_name
above.- mount
Point stringBase A mount point base name for shared storage.
- multipath boolean
Whether to connect to this volume via multipath.
- os
Type 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.- volume
Id 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 ofro
andrw
are accepted. If left unspecified, the Block Storage API will apply a default ofrw
.- 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_ strtype 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_ strbase 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.
- attach
Mode String Specify whether to attach the volume as Read-Only (
ro
) or Read-Write (rw
). Only values ofro
andrw
are accepted. If left unspecified, the Block Storage API will apply a default ofrw
.- 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
.- driver
Volume StringType The storage driver that the volume is based on.
- host
Name String The host to attach the volume to.
- initiator String
The iSCSI initiator string to make the connection.
- ip
Address String The IP address of the
host_name
above.- mount
Point StringBase A mount point base name for shared storage.
- multipath Boolean
Whether to connect to this volume via multipath.
- os
Type 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.- volume
Id 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.