1. Packages
  2. Powerflex Provider
  3. API Docs
  4. Volume
powerflex 1.8.0 published on Monday, Apr 14, 2025 by dell

powerflex.Volume

Explore with Pulumi AI

Import

/*

Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the “License”);

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

http://mozilla.org/MPL/2.0/

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an “AS IS” BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

*/

import volume by it’s id

$ pulumi import powerflex:index/volume:Volume volume_import_by_id "<id>"
Copy
  1. This will import the volume instance with specified ID into your Terraform state.

  2. After successful import, you can run terraform state list to ensure the resource has been imported successfully.

  3. Now, you can fill in the resource block with the appropriate arguments and settings that match the imported resource’s real-world configuration.

  4. Execute pulumi preview to see if your configuration and the imported resource are in sync. Make adjustments if needed.

  5. Finally, execute pulumi up to bring the resource fully under Terraform’s management.

  6. Now, the resource which was not part of terraform became part of Terraform managed infrastructure.

Create Volume Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);
@overload
def Volume(resource_name: str,
           args: VolumeArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Volume(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           size: Optional[float] = None,
           access_mode: Optional[str] = None,
           capacity_unit: Optional[str] = None,
           compression_method: Optional[str] = None,
           name: Optional[str] = None,
           protection_domain_id: Optional[str] = None,
           protection_domain_name: Optional[str] = None,
           remove_mode: Optional[str] = None,
           storage_pool_id: Optional[str] = None,
           storage_pool_name: Optional[str] = None,
           use_rm_cache: Optional[bool] = None,
           volume_type: Optional[str] = None)
func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)
public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)
public Volume(String name, VolumeArgs args)
public Volume(String name, VolumeArgs args, CustomResourceOptions options)
type: powerflex:Volume
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. VolumeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var volumeResource = new Powerflex.Volume("volumeResource", new()
{
    Size = 0,
    AccessMode = "string",
    CapacityUnit = "string",
    CompressionMethod = "string",
    Name = "string",
    ProtectionDomainId = "string",
    ProtectionDomainName = "string",
    RemoveMode = "string",
    StoragePoolId = "string",
    StoragePoolName = "string",
    UseRmCache = false,
    VolumeType = "string",
});
Copy
example, err := powerflex.NewVolume(ctx, "volumeResource", &powerflex.VolumeArgs{
	Size:                 pulumi.Float64(0),
	AccessMode:           pulumi.String("string"),
	CapacityUnit:         pulumi.String("string"),
	CompressionMethod:    pulumi.String("string"),
	Name:                 pulumi.String("string"),
	ProtectionDomainId:   pulumi.String("string"),
	ProtectionDomainName: pulumi.String("string"),
	RemoveMode:           pulumi.String("string"),
	StoragePoolId:        pulumi.String("string"),
	StoragePoolName:      pulumi.String("string"),
	UseRmCache:           pulumi.Bool(false),
	VolumeType:           pulumi.String("string"),
})
Copy
var volumeResource = new Volume("volumeResource", VolumeArgs.builder()
    .size(0)
    .accessMode("string")
    .capacityUnit("string")
    .compressionMethod("string")
    .name("string")
    .protectionDomainId("string")
    .protectionDomainName("string")
    .removeMode("string")
    .storagePoolId("string")
    .storagePoolName("string")
    .useRmCache(false)
    .volumeType("string")
    .build());
Copy
volume_resource = powerflex.Volume("volumeResource",
    size=0,
    access_mode="string",
    capacity_unit="string",
    compression_method="string",
    name="string",
    protection_domain_id="string",
    protection_domain_name="string",
    remove_mode="string",
    storage_pool_id="string",
    storage_pool_name="string",
    use_rm_cache=False,
    volume_type="string")
Copy
const volumeResource = new powerflex.Volume("volumeResource", {
    size: 0,
    accessMode: "string",
    capacityUnit: "string",
    compressionMethod: "string",
    name: "string",
    protectionDomainId: "string",
    protectionDomainName: "string",
    removeMode: "string",
    storagePoolId: "string",
    storagePoolName: "string",
    useRmCache: false,
    volumeType: "string",
});
Copy
type: powerflex:Volume
properties:
    accessMode: string
    capacityUnit: string
    compressionMethod: string
    name: string
    protectionDomainId: string
    protectionDomainName: string
    removeMode: string
    size: 0
    storagePoolId: string
    storagePoolName: string
    useRmCache: false
    volumeType: string
Copy

Volume Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Volume resource accepts the following input properties:

Size This property is required. double
Size of the volume. The unit of size is defined by capacity_unit. The storage capacity of a volume must be a multiple of 8GB and cannot be decreased.
AccessMode string
The Access mode of the volume. Valid values are ReadOnly and ReadWrite. Default value is ReadOnly.
CapacityUnit string
Unit of capacity of the volume. Must be one of GB and TB. Default value is GB.
CompressionMethod string
Compression Method of the volume. Valid values are None and Normal.
Name string
The name of the volume.
ProtectionDomainId string
ID of the Protection Domain under which the volume will be created. Conflicts with protection_domain_name. Cannot be updated.
ProtectionDomainName string
Name of the Protection Domain under which the volume will be created. Conflicts with protection_domain_id. Cannot be updated.
RemoveMode string
Remove mode of the volume. Valid values are ONLY_ME and INCLUDING_DESCENDANTS. Default value is ONLY_ME.
StoragePoolId string
ID of the Storage Pool under which the volume will be created. Conflicts with storage_pool_name. Cannot be updated.
StoragePoolName string
Name of the Storage Pool under which the volume will be created. Conflicts with storage_pool_id. Cannot be updated.
UseRmCache bool
use rm cache
VolumeType string
Volume type. Valid values are ThickProvisioned and ThinProvisioned. Default value is ThinProvisioned.
Size This property is required. float64
Size of the volume. The unit of size is defined by capacity_unit. The storage capacity of a volume must be a multiple of 8GB and cannot be decreased.
AccessMode string
The Access mode of the volume. Valid values are ReadOnly and ReadWrite. Default value is ReadOnly.
CapacityUnit string
Unit of capacity of the volume. Must be one of GB and TB. Default value is GB.
CompressionMethod string
Compression Method of the volume. Valid values are None and Normal.
Name string
The name of the volume.
ProtectionDomainId string
ID of the Protection Domain under which the volume will be created. Conflicts with protection_domain_name. Cannot be updated.
ProtectionDomainName string
Name of the Protection Domain under which the volume will be created. Conflicts with protection_domain_id. Cannot be updated.
RemoveMode string
Remove mode of the volume. Valid values are ONLY_ME and INCLUDING_DESCENDANTS. Default value is ONLY_ME.
StoragePoolId string
ID of the Storage Pool under which the volume will be created. Conflicts with storage_pool_name. Cannot be updated.
StoragePoolName string
Name of the Storage Pool under which the volume will be created. Conflicts with storage_pool_id. Cannot be updated.
UseRmCache bool
use rm cache
VolumeType string
Volume type. Valid values are ThickProvisioned and ThinProvisioned. Default value is ThinProvisioned.
size This property is required. Double
Size of the volume. The unit of size is defined by capacity_unit. The storage capacity of a volume must be a multiple of 8GB and cannot be decreased.
accessMode String
The Access mode of the volume. Valid values are ReadOnly and ReadWrite. Default value is ReadOnly.
capacityUnit String
Unit of capacity of the volume. Must be one of GB and TB. Default value is GB.
compressionMethod String
Compression Method of the volume. Valid values are None and Normal.
name String
The name of the volume.
protectionDomainId String
ID of the Protection Domain under which the volume will be created. Conflicts with protection_domain_name. Cannot be updated.
protectionDomainName String
Name of the Protection Domain under which the volume will be created. Conflicts with protection_domain_id. Cannot be updated.
removeMode String
Remove mode of the volume. Valid values are ONLY_ME and INCLUDING_DESCENDANTS. Default value is ONLY_ME.
storagePoolId String
ID of the Storage Pool under which the volume will be created. Conflicts with storage_pool_name. Cannot be updated.
storagePoolName String
Name of the Storage Pool under which the volume will be created. Conflicts with storage_pool_id. Cannot be updated.
useRmCache Boolean
use rm cache
volumeType String
Volume type. Valid values are ThickProvisioned and ThinProvisioned. Default value is ThinProvisioned.
size This property is required. number
Size of the volume. The unit of size is defined by capacity_unit. The storage capacity of a volume must be a multiple of 8GB and cannot be decreased.
accessMode string
The Access mode of the volume. Valid values are ReadOnly and ReadWrite. Default value is ReadOnly.
capacityUnit string
Unit of capacity of the volume. Must be one of GB and TB. Default value is GB.
compressionMethod string
Compression Method of the volume. Valid values are None and Normal.
name string
The name of the volume.
protectionDomainId string
ID of the Protection Domain under which the volume will be created. Conflicts with protection_domain_name. Cannot be updated.
protectionDomainName string
Name of the Protection Domain under which the volume will be created. Conflicts with protection_domain_id. Cannot be updated.
removeMode string
Remove mode of the volume. Valid values are ONLY_ME and INCLUDING_DESCENDANTS. Default value is ONLY_ME.
storagePoolId string
ID of the Storage Pool under which the volume will be created. Conflicts with storage_pool_name. Cannot be updated.
storagePoolName string
Name of the Storage Pool under which the volume will be created. Conflicts with storage_pool_id. Cannot be updated.
useRmCache boolean
use rm cache
volumeType string
Volume type. Valid values are ThickProvisioned and ThinProvisioned. Default value is ThinProvisioned.
size This property is required. float
Size of the volume. The unit of size is defined by capacity_unit. The storage capacity of a volume must be a multiple of 8GB and cannot be decreased.
access_mode str
The Access mode of the volume. Valid values are ReadOnly and ReadWrite. Default value is ReadOnly.
capacity_unit str
Unit of capacity of the volume. Must be one of GB and TB. Default value is GB.
compression_method str
Compression Method of the volume. Valid values are None and Normal.
name str
The name of the volume.
protection_domain_id str
ID of the Protection Domain under which the volume will be created. Conflicts with protection_domain_name. Cannot be updated.
protection_domain_name str
Name of the Protection Domain under which the volume will be created. Conflicts with protection_domain_id. Cannot be updated.
remove_mode str
Remove mode of the volume. Valid values are ONLY_ME and INCLUDING_DESCENDANTS. Default value is ONLY_ME.
storage_pool_id str
ID of the Storage Pool under which the volume will be created. Conflicts with storage_pool_name. Cannot be updated.
storage_pool_name str
Name of the Storage Pool under which the volume will be created. Conflicts with storage_pool_id. Cannot be updated.
use_rm_cache bool
use rm cache
volume_type str
Volume type. Valid values are ThickProvisioned and ThinProvisioned. Default value is ThinProvisioned.
size This property is required. Number
Size of the volume. The unit of size is defined by capacity_unit. The storage capacity of a volume must be a multiple of 8GB and cannot be decreased.
accessMode String
The Access mode of the volume. Valid values are ReadOnly and ReadWrite. Default value is ReadOnly.
capacityUnit String
Unit of capacity of the volume. Must be one of GB and TB. Default value is GB.
compressionMethod String
Compression Method of the volume. Valid values are None and Normal.
name String
The name of the volume.
protectionDomainId String
ID of the Protection Domain under which the volume will be created. Conflicts with protection_domain_name. Cannot be updated.
protectionDomainName String
Name of the Protection Domain under which the volume will be created. Conflicts with protection_domain_id. Cannot be updated.
removeMode String
Remove mode of the volume. Valid values are ONLY_ME and INCLUDING_DESCENDANTS. Default value is ONLY_ME.
storagePoolId String
ID of the Storage Pool under which the volume will be created. Conflicts with storage_pool_name. Cannot be updated.
storagePoolName String
Name of the Storage Pool under which the volume will be created. Conflicts with storage_pool_id. Cannot be updated.
useRmCache Boolean
use rm cache
volumeType String
Volume type. Valid values are ThickProvisioned and ThinProvisioned. Default value is ThinProvisioned.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
SizeInKb double
Size in KB
Id string
The provider-assigned unique ID for this managed resource.
SizeInKb float64
Size in KB
id String
The provider-assigned unique ID for this managed resource.
sizeInKb Double
Size in KB
id string
The provider-assigned unique ID for this managed resource.
sizeInKb number
Size in KB
id str
The provider-assigned unique ID for this managed resource.
size_in_kb float
Size in KB
id String
The provider-assigned unique ID for this managed resource.
sizeInKb Number
Size in KB

Look up Existing Volume Resource

Get an existing Volume 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?: VolumeState, opts?: CustomResourceOptions): Volume
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_mode: Optional[str] = None,
        capacity_unit: Optional[str] = None,
        compression_method: Optional[str] = None,
        name: Optional[str] = None,
        protection_domain_id: Optional[str] = None,
        protection_domain_name: Optional[str] = None,
        remove_mode: Optional[str] = None,
        size: Optional[float] = None,
        size_in_kb: Optional[float] = None,
        storage_pool_id: Optional[str] = None,
        storage_pool_name: Optional[str] = None,
        use_rm_cache: Optional[bool] = None,
        volume_type: Optional[str] = None) -> Volume
func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)
public static Volume Get(string name, Input<string> id, VolumeState? state, CustomResourceOptions? opts = null)
public static Volume get(String name, Output<String> id, VolumeState state, CustomResourceOptions options)
resources:  _:    type: powerflex:Volume    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccessMode string
The Access mode of the volume. Valid values are ReadOnly and ReadWrite. Default value is ReadOnly.
CapacityUnit string
Unit of capacity of the volume. Must be one of GB and TB. Default value is GB.
CompressionMethod string
Compression Method of the volume. Valid values are None and Normal.
Name string
The name of the volume.
ProtectionDomainId string
ID of the Protection Domain under which the volume will be created. Conflicts with protection_domain_name. Cannot be updated.
ProtectionDomainName string
Name of the Protection Domain under which the volume will be created. Conflicts with protection_domain_id. Cannot be updated.
RemoveMode string
Remove mode of the volume. Valid values are ONLY_ME and INCLUDING_DESCENDANTS. Default value is ONLY_ME.
Size double
Size of the volume. The unit of size is defined by capacity_unit. The storage capacity of a volume must be a multiple of 8GB and cannot be decreased.
SizeInKb double
Size in KB
StoragePoolId string
ID of the Storage Pool under which the volume will be created. Conflicts with storage_pool_name. Cannot be updated.
StoragePoolName string
Name of the Storage Pool under which the volume will be created. Conflicts with storage_pool_id. Cannot be updated.
UseRmCache bool
use rm cache
VolumeType string
Volume type. Valid values are ThickProvisioned and ThinProvisioned. Default value is ThinProvisioned.
AccessMode string
The Access mode of the volume. Valid values are ReadOnly and ReadWrite. Default value is ReadOnly.
CapacityUnit string
Unit of capacity of the volume. Must be one of GB and TB. Default value is GB.
CompressionMethod string
Compression Method of the volume. Valid values are None and Normal.
Name string
The name of the volume.
ProtectionDomainId string
ID of the Protection Domain under which the volume will be created. Conflicts with protection_domain_name. Cannot be updated.
ProtectionDomainName string
Name of the Protection Domain under which the volume will be created. Conflicts with protection_domain_id. Cannot be updated.
RemoveMode string
Remove mode of the volume. Valid values are ONLY_ME and INCLUDING_DESCENDANTS. Default value is ONLY_ME.
Size float64
Size of the volume. The unit of size is defined by capacity_unit. The storage capacity of a volume must be a multiple of 8GB and cannot be decreased.
SizeInKb float64
Size in KB
StoragePoolId string
ID of the Storage Pool under which the volume will be created. Conflicts with storage_pool_name. Cannot be updated.
StoragePoolName string
Name of the Storage Pool under which the volume will be created. Conflicts with storage_pool_id. Cannot be updated.
UseRmCache bool
use rm cache
VolumeType string
Volume type. Valid values are ThickProvisioned and ThinProvisioned. Default value is ThinProvisioned.
accessMode String
The Access mode of the volume. Valid values are ReadOnly and ReadWrite. Default value is ReadOnly.
capacityUnit String
Unit of capacity of the volume. Must be one of GB and TB. Default value is GB.
compressionMethod String
Compression Method of the volume. Valid values are None and Normal.
name String
The name of the volume.
protectionDomainId String
ID of the Protection Domain under which the volume will be created. Conflicts with protection_domain_name. Cannot be updated.
protectionDomainName String
Name of the Protection Domain under which the volume will be created. Conflicts with protection_domain_id. Cannot be updated.
removeMode String
Remove mode of the volume. Valid values are ONLY_ME and INCLUDING_DESCENDANTS. Default value is ONLY_ME.
size Double
Size of the volume. The unit of size is defined by capacity_unit. The storage capacity of a volume must be a multiple of 8GB and cannot be decreased.
sizeInKb Double
Size in KB
storagePoolId String
ID of the Storage Pool under which the volume will be created. Conflicts with storage_pool_name. Cannot be updated.
storagePoolName String
Name of the Storage Pool under which the volume will be created. Conflicts with storage_pool_id. Cannot be updated.
useRmCache Boolean
use rm cache
volumeType String
Volume type. Valid values are ThickProvisioned and ThinProvisioned. Default value is ThinProvisioned.
accessMode string
The Access mode of the volume. Valid values are ReadOnly and ReadWrite. Default value is ReadOnly.
capacityUnit string
Unit of capacity of the volume. Must be one of GB and TB. Default value is GB.
compressionMethod string
Compression Method of the volume. Valid values are None and Normal.
name string
The name of the volume.
protectionDomainId string
ID of the Protection Domain under which the volume will be created. Conflicts with protection_domain_name. Cannot be updated.
protectionDomainName string
Name of the Protection Domain under which the volume will be created. Conflicts with protection_domain_id. Cannot be updated.
removeMode string
Remove mode of the volume. Valid values are ONLY_ME and INCLUDING_DESCENDANTS. Default value is ONLY_ME.
size number
Size of the volume. The unit of size is defined by capacity_unit. The storage capacity of a volume must be a multiple of 8GB and cannot be decreased.
sizeInKb number
Size in KB
storagePoolId string
ID of the Storage Pool under which the volume will be created. Conflicts with storage_pool_name. Cannot be updated.
storagePoolName string
Name of the Storage Pool under which the volume will be created. Conflicts with storage_pool_id. Cannot be updated.
useRmCache boolean
use rm cache
volumeType string
Volume type. Valid values are ThickProvisioned and ThinProvisioned. Default value is ThinProvisioned.
access_mode str
The Access mode of the volume. Valid values are ReadOnly and ReadWrite. Default value is ReadOnly.
capacity_unit str
Unit of capacity of the volume. Must be one of GB and TB. Default value is GB.
compression_method str
Compression Method of the volume. Valid values are None and Normal.
name str
The name of the volume.
protection_domain_id str
ID of the Protection Domain under which the volume will be created. Conflicts with protection_domain_name. Cannot be updated.
protection_domain_name str
Name of the Protection Domain under which the volume will be created. Conflicts with protection_domain_id. Cannot be updated.
remove_mode str
Remove mode of the volume. Valid values are ONLY_ME and INCLUDING_DESCENDANTS. Default value is ONLY_ME.
size float
Size of the volume. The unit of size is defined by capacity_unit. The storage capacity of a volume must be a multiple of 8GB and cannot be decreased.
size_in_kb float
Size in KB
storage_pool_id str
ID of the Storage Pool under which the volume will be created. Conflicts with storage_pool_name. Cannot be updated.
storage_pool_name str
Name of the Storage Pool under which the volume will be created. Conflicts with storage_pool_id. Cannot be updated.
use_rm_cache bool
use rm cache
volume_type str
Volume type. Valid values are ThickProvisioned and ThinProvisioned. Default value is ThinProvisioned.
accessMode String
The Access mode of the volume. Valid values are ReadOnly and ReadWrite. Default value is ReadOnly.
capacityUnit String
Unit of capacity of the volume. Must be one of GB and TB. Default value is GB.
compressionMethod String
Compression Method of the volume. Valid values are None and Normal.
name String
The name of the volume.
protectionDomainId String
ID of the Protection Domain under which the volume will be created. Conflicts with protection_domain_name. Cannot be updated.
protectionDomainName String
Name of the Protection Domain under which the volume will be created. Conflicts with protection_domain_id. Cannot be updated.
removeMode String
Remove mode of the volume. Valid values are ONLY_ME and INCLUDING_DESCENDANTS. Default value is ONLY_ME.
size Number
Size of the volume. The unit of size is defined by capacity_unit. The storage capacity of a volume must be a multiple of 8GB and cannot be decreased.
sizeInKb Number
Size in KB
storagePoolId String
ID of the Storage Pool under which the volume will be created. Conflicts with storage_pool_name. Cannot be updated.
storagePoolName String
Name of the Storage Pool under which the volume will be created. Conflicts with storage_pool_id. Cannot be updated.
useRmCache Boolean
use rm cache
volumeType String
Volume type. Valid values are ThickProvisioned and ThinProvisioned. Default value is ThinProvisioned.

Package Details

Repository
powerflex dell/terraform-provider-powerflex
License
Notes
This Pulumi package is based on the powerflex Terraform Provider.