Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nomad Provider
  3. API Docs
  4. CsiVolume
Nomad v2.5.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-nomad

nomad.CsiVolume

Explore with Pulumi AI

Nomad v2.5.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-nomad

Create CsiVolume Resource

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

Constructor syntax

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

@overload
def CsiVolume(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              capabilities: Optional[Sequence[CsiVolumeCapabilityArgs]] = None,
              volume_id: Optional[str] = None,
              plugin_id: Optional[str] = None,
              namespace: Optional[str] = None,
              mount_options: Optional[CsiVolumeMountOptionsArgs] = None,
              name: Optional[str] = None,
              clone_id: Optional[str] = None,
              parameters: Optional[Mapping[str, str]] = None,
              capacity_min: Optional[str] = None,
              secrets: Optional[Mapping[str, str]] = None,
              snapshot_id: Optional[str] = None,
              topology_request: Optional[CsiVolumeTopologyRequestArgs] = None,
              capacity_max: Optional[str] = None)
func NewCsiVolume(ctx *Context, name string, args CsiVolumeArgs, opts ...ResourceOption) (*CsiVolume, error)
public CsiVolume(string name, CsiVolumeArgs args, CustomResourceOptions? opts = null)
public CsiVolume(String name, CsiVolumeArgs args)
public CsiVolume(String name, CsiVolumeArgs args, CustomResourceOptions options)

type: nomad:CsiVolume
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. CsiVolumeArgs
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. CsiVolumeArgs
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. CsiVolumeArgs
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. CsiVolumeArgs
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. CsiVolumeArgs
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 csiVolumeResource = new Nomad.CsiVolume("csiVolumeResource", new()
{
    Capabilities = new[]
    {
        new Nomad.Inputs.CsiVolumeCapabilityArgs
        {
            AccessMode = "string",
            AttachmentMode = "string",
        },
    },
    VolumeId = "string",
    PluginId = "string",
    Namespace = "string",
    MountOptions = new Nomad.Inputs.CsiVolumeMountOptionsArgs
    {
        FsType = "string",
        MountFlags = new[]
        {
            "string",
        },
    },
    Name = "string",
    CloneId = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    CapacityMin = "string",
    Secrets = 
    {
        { "string", "string" },
    },
    SnapshotId = "string",
    TopologyRequest = new Nomad.Inputs.CsiVolumeTopologyRequestArgs
    {
        Preferred = new Nomad.Inputs.CsiVolumeTopologyRequestPreferredArgs
        {
            Topologies = new[]
            {
                new Nomad.Inputs.CsiVolumeTopologyRequestPreferredTopologyArgs
                {
                    Segments = 
                    {
                        { "string", "string" },
                    },
                },
            },
        },
        Required = new Nomad.Inputs.CsiVolumeTopologyRequestRequiredArgs
        {
            Topologies = new[]
            {
                new Nomad.Inputs.CsiVolumeTopologyRequestRequiredTopologyArgs
                {
                    Segments = 
                    {
                        { "string", "string" },
                    },
                },
            },
        },
    },
    CapacityMax = "string",
});
Copy
example, err := nomad.NewCsiVolume(ctx, "csiVolumeResource", &nomad.CsiVolumeArgs{
	Capabilities: nomad.CsiVolumeCapabilityArray{
		&nomad.CsiVolumeCapabilityArgs{
			AccessMode:     pulumi.String("string"),
			AttachmentMode: pulumi.String("string"),
		},
	},
	VolumeId:  pulumi.String("string"),
	PluginId:  pulumi.String("string"),
	Namespace: pulumi.String("string"),
	MountOptions: &nomad.CsiVolumeMountOptionsArgs{
		FsType: pulumi.String("string"),
		MountFlags: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Name:    pulumi.String("string"),
	CloneId: pulumi.String("string"),
	Parameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CapacityMin: pulumi.String("string"),
	Secrets: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SnapshotId: pulumi.String("string"),
	TopologyRequest: &nomad.CsiVolumeTopologyRequestArgs{
		Preferred: &nomad.CsiVolumeTopologyRequestPreferredArgs{
			Topologies: nomad.CsiVolumeTopologyRequestPreferredTopologyArray{
				&nomad.CsiVolumeTopologyRequestPreferredTopologyArgs{
					Segments: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
				},
			},
		},
		Required: &nomad.CsiVolumeTopologyRequestRequiredArgs{
			Topologies: nomad.CsiVolumeTopologyRequestRequiredTopologyArray{
				&nomad.CsiVolumeTopologyRequestRequiredTopologyArgs{
					Segments: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
				},
			},
		},
	},
	CapacityMax: pulumi.String("string"),
})
Copy
var csiVolumeResource = new CsiVolume("csiVolumeResource", CsiVolumeArgs.builder()
    .capabilities(CsiVolumeCapabilityArgs.builder()
        .accessMode("string")
        .attachmentMode("string")
        .build())
    .volumeId("string")
    .pluginId("string")
    .namespace("string")
    .mountOptions(CsiVolumeMountOptionsArgs.builder()
        .fsType("string")
        .mountFlags("string")
        .build())
    .name("string")
    .cloneId("string")
    .parameters(Map.of("string", "string"))
    .capacityMin("string")
    .secrets(Map.of("string", "string"))
    .snapshotId("string")
    .topologyRequest(CsiVolumeTopologyRequestArgs.builder()
        .preferred(CsiVolumeTopologyRequestPreferredArgs.builder()
            .topologies(CsiVolumeTopologyRequestPreferredTopologyArgs.builder()
                .segments(Map.of("string", "string"))
                .build())
            .build())
        .required(CsiVolumeTopologyRequestRequiredArgs.builder()
            .topologies(CsiVolumeTopologyRequestRequiredTopologyArgs.builder()
                .segments(Map.of("string", "string"))
                .build())
            .build())
        .build())
    .capacityMax("string")
    .build());
Copy
csi_volume_resource = nomad.CsiVolume("csiVolumeResource",
    capabilities=[{
        "access_mode": "string",
        "attachment_mode": "string",
    }],
    volume_id="string",
    plugin_id="string",
    namespace="string",
    mount_options={
        "fs_type": "string",
        "mount_flags": ["string"],
    },
    name="string",
    clone_id="string",
    parameters={
        "string": "string",
    },
    capacity_min="string",
    secrets={
        "string": "string",
    },
    snapshot_id="string",
    topology_request={
        "preferred": {
            "topologies": [{
                "segments": {
                    "string": "string",
                },
            }],
        },
        "required": {
            "topologies": [{
                "segments": {
                    "string": "string",
                },
            }],
        },
    },
    capacity_max="string")
Copy
const csiVolumeResource = new nomad.CsiVolume("csiVolumeResource", {
    capabilities: [{
        accessMode: "string",
        attachmentMode: "string",
    }],
    volumeId: "string",
    pluginId: "string",
    namespace: "string",
    mountOptions: {
        fsType: "string",
        mountFlags: ["string"],
    },
    name: "string",
    cloneId: "string",
    parameters: {
        string: "string",
    },
    capacityMin: "string",
    secrets: {
        string: "string",
    },
    snapshotId: "string",
    topologyRequest: {
        preferred: {
            topologies: [{
                segments: {
                    string: "string",
                },
            }],
        },
        required: {
            topologies: [{
                segments: {
                    string: "string",
                },
            }],
        },
    },
    capacityMax: "string",
});
Copy
type: nomad:CsiVolume
properties:
    capabilities:
        - accessMode: string
          attachmentMode: string
    capacityMax: string
    capacityMin: string
    cloneId: string
    mountOptions:
        fsType: string
        mountFlags:
            - string
    name: string
    namespace: string
    parameters:
        string: string
    pluginId: string
    secrets:
        string: string
    snapshotId: string
    topologyRequest:
        preferred:
            topologies:
                - segments:
                    string: string
        required:
            topologies:
                - segments:
                    string: string
    volumeId: string
Copy

CsiVolume 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 CsiVolume resource accepts the following input properties:

Capabilities
This property is required.
Changes to this property will trigger replacement.
List<CsiVolumeCapability>
(``Capability``: <required>) - Options for validating the capability of a volume.
PluginId
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - The ID of the Nomad plugin for registering this volume.
VolumeId
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - The unique ID of the volume.
CapacityMax string
(string: <optional>) - Option to signal a maximum volume size. This may not be supported by all storage providers.
CapacityMin string
(string: <optional>) - Option to signal a minimum volume size. This may not be supported by all storage providers.
CloneId Changes to this property will trigger replacement. string
(string: <optional>) - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with snapshot_id.
MountOptions CsiVolumeMountOptions
(block: optional) Options for mounting block-device volumes without a pre-formatted file system.
Name string
(string: <required>) - The display name for the volume.
Namespace Changes to this property will trigger replacement. string
(string: "default") - The namespace in which to register the volume.
Parameters Dictionary<string, string>
(map[string]string: optional) An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
Secrets Dictionary<string, string>
(map[string]string: optional) An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
SnapshotId Changes to this property will trigger replacement. string
(string: <optional>) - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with clone_id.
TopologyRequest Changes to this property will trigger replacement. CsiVolumeTopologyRequest
(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
Capabilities
This property is required.
Changes to this property will trigger replacement.
[]CsiVolumeCapabilityArgs
(``Capability``: <required>) - Options for validating the capability of a volume.
PluginId
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - The ID of the Nomad plugin for registering this volume.
VolumeId
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - The unique ID of the volume.
CapacityMax string
(string: <optional>) - Option to signal a maximum volume size. This may not be supported by all storage providers.
CapacityMin string
(string: <optional>) - Option to signal a minimum volume size. This may not be supported by all storage providers.
CloneId Changes to this property will trigger replacement. string
(string: <optional>) - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with snapshot_id.
MountOptions CsiVolumeMountOptionsArgs
(block: optional) Options for mounting block-device volumes without a pre-formatted file system.
Name string
(string: <required>) - The display name for the volume.
Namespace Changes to this property will trigger replacement. string
(string: "default") - The namespace in which to register the volume.
Parameters map[string]string
(map[string]string: optional) An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
Secrets map[string]string
(map[string]string: optional) An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
SnapshotId Changes to this property will trigger replacement. string
(string: <optional>) - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with clone_id.
TopologyRequest Changes to this property will trigger replacement. CsiVolumeTopologyRequestArgs
(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
capabilities
This property is required.
Changes to this property will trigger replacement.
List<CsiVolumeCapability>
(``Capability``: <required>) - Options for validating the capability of a volume.
pluginId
This property is required.
Changes to this property will trigger replacement.
String
(string: <required>) - The ID of the Nomad plugin for registering this volume.
volumeId
This property is required.
Changes to this property will trigger replacement.
String
(string: <required>) - The unique ID of the volume.
capacityMax String
(string: <optional>) - Option to signal a maximum volume size. This may not be supported by all storage providers.
capacityMin String
(string: <optional>) - Option to signal a minimum volume size. This may not be supported by all storage providers.
cloneId Changes to this property will trigger replacement. String
(string: <optional>) - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with snapshot_id.
mountOptions CsiVolumeMountOptions
(block: optional) Options for mounting block-device volumes without a pre-formatted file system.
name String
(string: <required>) - The display name for the volume.
namespace Changes to this property will trigger replacement. String
(string: "default") - The namespace in which to register the volume.
parameters Map<String,String>
(map[string]string: optional) An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
secrets Map<String,String>
(map[string]string: optional) An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
snapshotId Changes to this property will trigger replacement. String
(string: <optional>) - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with clone_id.
topologyRequest Changes to this property will trigger replacement. CsiVolumeTopologyRequest
(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
capabilities
This property is required.
Changes to this property will trigger replacement.
CsiVolumeCapability[]
(``Capability``: <required>) - Options for validating the capability of a volume.
pluginId
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - The ID of the Nomad plugin for registering this volume.
volumeId
This property is required.
Changes to this property will trigger replacement.
string
(string: <required>) - The unique ID of the volume.
capacityMax string
(string: <optional>) - Option to signal a maximum volume size. This may not be supported by all storage providers.
capacityMin string
(string: <optional>) - Option to signal a minimum volume size. This may not be supported by all storage providers.
cloneId Changes to this property will trigger replacement. string
(string: <optional>) - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with snapshot_id.
mountOptions CsiVolumeMountOptions
(block: optional) Options for mounting block-device volumes without a pre-formatted file system.
name string
(string: <required>) - The display name for the volume.
namespace Changes to this property will trigger replacement. string
(string: "default") - The namespace in which to register the volume.
parameters {[key: string]: string}
(map[string]string: optional) An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
secrets {[key: string]: string}
(map[string]string: optional) An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
snapshotId Changes to this property will trigger replacement. string
(string: <optional>) - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with clone_id.
topologyRequest Changes to this property will trigger replacement. CsiVolumeTopologyRequest
(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
capabilities
This property is required.
Changes to this property will trigger replacement.
Sequence[CsiVolumeCapabilityArgs]
(``Capability``: <required>) - Options for validating the capability of a volume.
plugin_id
This property is required.
Changes to this property will trigger replacement.
str
(string: <required>) - The ID of the Nomad plugin for registering this volume.
volume_id
This property is required.
Changes to this property will trigger replacement.
str
(string: <required>) - The unique ID of the volume.
capacity_max str
(string: <optional>) - Option to signal a maximum volume size. This may not be supported by all storage providers.
capacity_min str
(string: <optional>) - Option to signal a minimum volume size. This may not be supported by all storage providers.
clone_id Changes to this property will trigger replacement. str
(string: <optional>) - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with snapshot_id.
mount_options CsiVolumeMountOptionsArgs
(block: optional) Options for mounting block-device volumes without a pre-formatted file system.
name str
(string: <required>) - The display name for the volume.
namespace Changes to this property will trigger replacement. str
(string: "default") - The namespace in which to register the volume.
parameters Mapping[str, str]
(map[string]string: optional) An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
secrets Mapping[str, str]
(map[string]string: optional) An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
snapshot_id Changes to this property will trigger replacement. str
(string: <optional>) - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with clone_id.
topology_request Changes to this property will trigger replacement. CsiVolumeTopologyRequestArgs
(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
capabilities
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
(``Capability``: <required>) - Options for validating the capability of a volume.
pluginId
This property is required.
Changes to this property will trigger replacement.
String
(string: <required>) - The ID of the Nomad plugin for registering this volume.
volumeId
This property is required.
Changes to this property will trigger replacement.
String
(string: <required>) - The unique ID of the volume.
capacityMax String
(string: <optional>) - Option to signal a maximum volume size. This may not be supported by all storage providers.
capacityMin String
(string: <optional>) - Option to signal a minimum volume size. This may not be supported by all storage providers.
cloneId Changes to this property will trigger replacement. String
(string: <optional>) - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with snapshot_id.
mountOptions Property Map
(block: optional) Options for mounting block-device volumes without a pre-formatted file system.
name String
(string: <required>) - The display name for the volume.
namespace Changes to this property will trigger replacement. String
(string: "default") - The namespace in which to register the volume.
parameters Map<String>
(map[string]string: optional) An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
secrets Map<String>
(map[string]string: optional) An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
snapshotId Changes to this property will trigger replacement. String
(string: <optional>) - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with clone_id.
topologyRequest Changes to this property will trigger replacement. Property Map
(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.

Outputs

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

Capacity int
CapacityMaxBytes int
CapacityMinBytes int
Context Dictionary<string, string>
The volume context provided by the storage provider
ControllerRequired bool
ControllersExpected int
ControllersHealthy int
ExternalId string
The ID of the physical volume from the storage provider.
Id string
The provider-assigned unique ID for this managed resource.
NodesExpected int
NodesHealthy int
PluginProvider string
PluginProviderVersion string
Schedulable bool
Topologies List<CsiVolumeTopology>
Capacity int
CapacityMaxBytes int
CapacityMinBytes int
Context map[string]string
The volume context provided by the storage provider
ControllerRequired bool
ControllersExpected int
ControllersHealthy int
ExternalId string
The ID of the physical volume from the storage provider.
Id string
The provider-assigned unique ID for this managed resource.
NodesExpected int
NodesHealthy int
PluginProvider string
PluginProviderVersion string
Schedulable bool
Topologies []CsiVolumeTopology
capacity Integer
capacityMaxBytes Integer
capacityMinBytes Integer
context Map<String,String>
The volume context provided by the storage provider
controllerRequired Boolean
controllersExpected Integer
controllersHealthy Integer
externalId String
The ID of the physical volume from the storage provider.
id String
The provider-assigned unique ID for this managed resource.
nodesExpected Integer
nodesHealthy Integer
pluginProvider String
pluginProviderVersion String
schedulable Boolean
topologies List<CsiVolumeTopology>
capacity number
capacityMaxBytes number
capacityMinBytes number
context {[key: string]: string}
The volume context provided by the storage provider
controllerRequired boolean
controllersExpected number
controllersHealthy number
externalId string
The ID of the physical volume from the storage provider.
id string
The provider-assigned unique ID for this managed resource.
nodesExpected number
nodesHealthy number
pluginProvider string
pluginProviderVersion string
schedulable boolean
topologies CsiVolumeTopology[]
capacity int
capacity_max_bytes int
capacity_min_bytes int
context Mapping[str, str]
The volume context provided by the storage provider
controller_required bool
controllers_expected int
controllers_healthy int
external_id str
The ID of the physical volume from the storage provider.
id str
The provider-assigned unique ID for this managed resource.
nodes_expected int
nodes_healthy int
plugin_provider str
plugin_provider_version str
schedulable bool
topologies Sequence[CsiVolumeTopology]
capacity Number
capacityMaxBytes Number
capacityMinBytes Number
context Map<String>
The volume context provided by the storage provider
controllerRequired Boolean
controllersExpected Number
controllersHealthy Number
externalId String
The ID of the physical volume from the storage provider.
id String
The provider-assigned unique ID for this managed resource.
nodesExpected Number
nodesHealthy Number
pluginProvider String
pluginProviderVersion String
schedulable Boolean
topologies List<Property Map>

Look up Existing CsiVolume Resource

Get an existing CsiVolume 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?: CsiVolumeState, opts?: CustomResourceOptions): CsiVolume
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capabilities: Optional[Sequence[CsiVolumeCapabilityArgs]] = None,
        capacity: Optional[int] = None,
        capacity_max: Optional[str] = None,
        capacity_max_bytes: Optional[int] = None,
        capacity_min: Optional[str] = None,
        capacity_min_bytes: Optional[int] = None,
        clone_id: Optional[str] = None,
        context: Optional[Mapping[str, str]] = None,
        controller_required: Optional[bool] = None,
        controllers_expected: Optional[int] = None,
        controllers_healthy: Optional[int] = None,
        external_id: Optional[str] = None,
        mount_options: Optional[CsiVolumeMountOptionsArgs] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        nodes_expected: Optional[int] = None,
        nodes_healthy: Optional[int] = None,
        parameters: Optional[Mapping[str, str]] = None,
        plugin_id: Optional[str] = None,
        plugin_provider: Optional[str] = None,
        plugin_provider_version: Optional[str] = None,
        schedulable: Optional[bool] = None,
        secrets: Optional[Mapping[str, str]] = None,
        snapshot_id: Optional[str] = None,
        topologies: Optional[Sequence[CsiVolumeTopologyArgs]] = None,
        topology_request: Optional[CsiVolumeTopologyRequestArgs] = None,
        volume_id: Optional[str] = None) -> CsiVolume
func GetCsiVolume(ctx *Context, name string, id IDInput, state *CsiVolumeState, opts ...ResourceOption) (*CsiVolume, error)
public static CsiVolume Get(string name, Input<string> id, CsiVolumeState? state, CustomResourceOptions? opts = null)
public static CsiVolume get(String name, Output<String> id, CsiVolumeState state, CustomResourceOptions options)
resources:  _:    type: nomad:CsiVolume    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:
Capabilities Changes to this property will trigger replacement. List<CsiVolumeCapability>
(``Capability``: <required>) - Options for validating the capability of a volume.
Capacity int
CapacityMax string
(string: <optional>) - Option to signal a maximum volume size. This may not be supported by all storage providers.
CapacityMaxBytes int
CapacityMin string
(string: <optional>) - Option to signal a minimum volume size. This may not be supported by all storage providers.
CapacityMinBytes int
CloneId Changes to this property will trigger replacement. string
(string: <optional>) - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with snapshot_id.
Context Dictionary<string, string>
The volume context provided by the storage provider
ControllerRequired bool
ControllersExpected int
ControllersHealthy int
ExternalId string
The ID of the physical volume from the storage provider.
MountOptions CsiVolumeMountOptions
(block: optional) Options for mounting block-device volumes without a pre-formatted file system.
Name string
(string: <required>) - The display name for the volume.
Namespace Changes to this property will trigger replacement. string
(string: "default") - The namespace in which to register the volume.
NodesExpected int
NodesHealthy int
Parameters Dictionary<string, string>
(map[string]string: optional) An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
PluginId Changes to this property will trigger replacement. string
(string: <required>) - The ID of the Nomad plugin for registering this volume.
PluginProvider string
PluginProviderVersion string
Schedulable bool
Secrets Dictionary<string, string>
(map[string]string: optional) An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
SnapshotId Changes to this property will trigger replacement. string
(string: <optional>) - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with clone_id.
Topologies List<CsiVolumeTopology>
TopologyRequest Changes to this property will trigger replacement. CsiVolumeTopologyRequest
(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
VolumeId Changes to this property will trigger replacement. string
(string: <required>) - The unique ID of the volume.
Capabilities Changes to this property will trigger replacement. []CsiVolumeCapabilityArgs
(``Capability``: <required>) - Options for validating the capability of a volume.
Capacity int
CapacityMax string
(string: <optional>) - Option to signal a maximum volume size. This may not be supported by all storage providers.
CapacityMaxBytes int
CapacityMin string
(string: <optional>) - Option to signal a minimum volume size. This may not be supported by all storage providers.
CapacityMinBytes int
CloneId Changes to this property will trigger replacement. string
(string: <optional>) - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with snapshot_id.
Context map[string]string
The volume context provided by the storage provider
ControllerRequired bool
ControllersExpected int
ControllersHealthy int
ExternalId string
The ID of the physical volume from the storage provider.
MountOptions CsiVolumeMountOptionsArgs
(block: optional) Options for mounting block-device volumes without a pre-formatted file system.
Name string
(string: <required>) - The display name for the volume.
Namespace Changes to this property will trigger replacement. string
(string: "default") - The namespace in which to register the volume.
NodesExpected int
NodesHealthy int
Parameters map[string]string
(map[string]string: optional) An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
PluginId Changes to this property will trigger replacement. string
(string: <required>) - The ID of the Nomad plugin for registering this volume.
PluginProvider string
PluginProviderVersion string
Schedulable bool
Secrets map[string]string
(map[string]string: optional) An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
SnapshotId Changes to this property will trigger replacement. string
(string: <optional>) - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with clone_id.
Topologies []CsiVolumeTopologyArgs
TopologyRequest Changes to this property will trigger replacement. CsiVolumeTopologyRequestArgs
(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
VolumeId Changes to this property will trigger replacement. string
(string: <required>) - The unique ID of the volume.
capabilities Changes to this property will trigger replacement. List<CsiVolumeCapability>
(``Capability``: <required>) - Options for validating the capability of a volume.
capacity Integer
capacityMax String
(string: <optional>) - Option to signal a maximum volume size. This may not be supported by all storage providers.
capacityMaxBytes Integer
capacityMin String
(string: <optional>) - Option to signal a minimum volume size. This may not be supported by all storage providers.
capacityMinBytes Integer
cloneId Changes to this property will trigger replacement. String
(string: <optional>) - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with snapshot_id.
context Map<String,String>
The volume context provided by the storage provider
controllerRequired Boolean
controllersExpected Integer
controllersHealthy Integer
externalId String
The ID of the physical volume from the storage provider.
mountOptions CsiVolumeMountOptions
(block: optional) Options for mounting block-device volumes without a pre-formatted file system.
name String
(string: <required>) - The display name for the volume.
namespace Changes to this property will trigger replacement. String
(string: "default") - The namespace in which to register the volume.
nodesExpected Integer
nodesHealthy Integer
parameters Map<String,String>
(map[string]string: optional) An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
pluginId Changes to this property will trigger replacement. String
(string: <required>) - The ID of the Nomad plugin for registering this volume.
pluginProvider String
pluginProviderVersion String
schedulable Boolean
secrets Map<String,String>
(map[string]string: optional) An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
snapshotId Changes to this property will trigger replacement. String
(string: <optional>) - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with clone_id.
topologies List<CsiVolumeTopology>
topologyRequest Changes to this property will trigger replacement. CsiVolumeTopologyRequest
(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
volumeId Changes to this property will trigger replacement. String
(string: <required>) - The unique ID of the volume.
capabilities Changes to this property will trigger replacement. CsiVolumeCapability[]
(``Capability``: <required>) - Options for validating the capability of a volume.
capacity number
capacityMax string
(string: <optional>) - Option to signal a maximum volume size. This may not be supported by all storage providers.
capacityMaxBytes number
capacityMin string
(string: <optional>) - Option to signal a minimum volume size. This may not be supported by all storage providers.
capacityMinBytes number
cloneId Changes to this property will trigger replacement. string
(string: <optional>) - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with snapshot_id.
context {[key: string]: string}
The volume context provided by the storage provider
controllerRequired boolean
controllersExpected number
controllersHealthy number
externalId string
The ID of the physical volume from the storage provider.
mountOptions CsiVolumeMountOptions
(block: optional) Options for mounting block-device volumes without a pre-formatted file system.
name string
(string: <required>) - The display name for the volume.
namespace Changes to this property will trigger replacement. string
(string: "default") - The namespace in which to register the volume.
nodesExpected number
nodesHealthy number
parameters {[key: string]: string}
(map[string]string: optional) An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
pluginId Changes to this property will trigger replacement. string
(string: <required>) - The ID of the Nomad plugin for registering this volume.
pluginProvider string
pluginProviderVersion string
schedulable boolean
secrets {[key: string]: string}
(map[string]string: optional) An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
snapshotId Changes to this property will trigger replacement. string
(string: <optional>) - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with clone_id.
topologies CsiVolumeTopology[]
topologyRequest Changes to this property will trigger replacement. CsiVolumeTopologyRequest
(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
volumeId Changes to this property will trigger replacement. string
(string: <required>) - The unique ID of the volume.
capabilities Changes to this property will trigger replacement. Sequence[CsiVolumeCapabilityArgs]
(``Capability``: <required>) - Options for validating the capability of a volume.
capacity int
capacity_max str
(string: <optional>) - Option to signal a maximum volume size. This may not be supported by all storage providers.
capacity_max_bytes int
capacity_min str
(string: <optional>) - Option to signal a minimum volume size. This may not be supported by all storage providers.
capacity_min_bytes int
clone_id Changes to this property will trigger replacement. str
(string: <optional>) - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with snapshot_id.
context Mapping[str, str]
The volume context provided by the storage provider
controller_required bool
controllers_expected int
controllers_healthy int
external_id str
The ID of the physical volume from the storage provider.
mount_options CsiVolumeMountOptionsArgs
(block: optional) Options for mounting block-device volumes without a pre-formatted file system.
name str
(string: <required>) - The display name for the volume.
namespace Changes to this property will trigger replacement. str
(string: "default") - The namespace in which to register the volume.
nodes_expected int
nodes_healthy int
parameters Mapping[str, str]
(map[string]string: optional) An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
plugin_id Changes to this property will trigger replacement. str
(string: <required>) - The ID of the Nomad plugin for registering this volume.
plugin_provider str
plugin_provider_version str
schedulable bool
secrets Mapping[str, str]
(map[string]string: optional) An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
snapshot_id Changes to this property will trigger replacement. str
(string: <optional>) - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with clone_id.
topologies Sequence[CsiVolumeTopologyArgs]
topology_request Changes to this property will trigger replacement. CsiVolumeTopologyRequestArgs
(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
volume_id Changes to this property will trigger replacement. str
(string: <required>) - The unique ID of the volume.
capabilities Changes to this property will trigger replacement. List<Property Map>
(``Capability``: <required>) - Options for validating the capability of a volume.
capacity Number
capacityMax String
(string: <optional>) - Option to signal a maximum volume size. This may not be supported by all storage providers.
capacityMaxBytes Number
capacityMin String
(string: <optional>) - Option to signal a minimum volume size. This may not be supported by all storage providers.
capacityMinBytes Number
cloneId Changes to this property will trigger replacement. String
(string: <optional>) - The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts with snapshot_id.
context Map<String>
The volume context provided by the storage provider
controllerRequired Boolean
controllersExpected Number
controllersHealthy Number
externalId String
The ID of the physical volume from the storage provider.
mountOptions Property Map
(block: optional) Options for mounting block-device volumes without a pre-formatted file system.
name String
(string: <required>) - The display name for the volume.
namespace Changes to this property will trigger replacement. String
(string: "default") - The namespace in which to register the volume.
nodesExpected Number
nodesHealthy Number
parameters Map<String>
(map[string]string: optional) An optional key-value map of strings passed directly to the CSI plugin to configure the volume.
pluginId Changes to this property will trigger replacement. String
(string: <required>) - The ID of the Nomad plugin for registering this volume.
pluginProvider String
pluginProviderVersion String
schedulable Boolean
secrets Map<String>
(map[string]string: optional) An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
snapshotId Changes to this property will trigger replacement. String
(string: <optional>) - The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts with clone_id.
topologies List<Property Map>
topologyRequest Changes to this property will trigger replacement. Property Map
(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
volumeId Changes to this property will trigger replacement. String
(string: <required>) - The unique ID of the volume.

Supporting Types

CsiVolumeCapability
, CsiVolumeCapabilityArgs

AccessMode This property is required. string
(string: <required>) - Defines whether a volume should be available concurrently. Possible values are:

  • single-node-reader-only
  • single-node-writer
  • multi-node-reader-only
  • multi-node-single-writer
  • multi-node-multi-writer
AttachmentMode This property is required. string
(string: <required>) - The storage API that will be used by the volume. Possible values are:

  • block-device
  • file-system
AccessMode This property is required. string
(string: <required>) - Defines whether a volume should be available concurrently. Possible values are:

  • single-node-reader-only
  • single-node-writer
  • multi-node-reader-only
  • multi-node-single-writer
  • multi-node-multi-writer
AttachmentMode This property is required. string
(string: <required>) - The storage API that will be used by the volume. Possible values are:

  • block-device
  • file-system
accessMode This property is required. String
(string: <required>) - Defines whether a volume should be available concurrently. Possible values are:

  • single-node-reader-only
  • single-node-writer
  • multi-node-reader-only
  • multi-node-single-writer
  • multi-node-multi-writer
attachmentMode This property is required. String
(string: <required>) - The storage API that will be used by the volume. Possible values are:

  • block-device
  • file-system
accessMode This property is required. string
(string: <required>) - Defines whether a volume should be available concurrently. Possible values are:

  • single-node-reader-only
  • single-node-writer
  • multi-node-reader-only
  • multi-node-single-writer
  • multi-node-multi-writer
attachmentMode This property is required. string
(string: <required>) - The storage API that will be used by the volume. Possible values are:

  • block-device
  • file-system
access_mode This property is required. str
(string: <required>) - Defines whether a volume should be available concurrently. Possible values are:

  • single-node-reader-only
  • single-node-writer
  • multi-node-reader-only
  • multi-node-single-writer
  • multi-node-multi-writer
attachment_mode This property is required. str
(string: <required>) - The storage API that will be used by the volume. Possible values are:

  • block-device
  • file-system
accessMode This property is required. String
(string: <required>) - Defines whether a volume should be available concurrently. Possible values are:

  • single-node-reader-only
  • single-node-writer
  • multi-node-reader-only
  • multi-node-single-writer
  • multi-node-multi-writer
attachmentMode This property is required. String
(string: <required>) - The storage API that will be used by the volume. Possible values are:

  • block-device
  • file-system

CsiVolumeMountOptions
, CsiVolumeMountOptionsArgs

FsType string
(string: optional) - The file system type.
MountFlags List<string>
[]string: optional - The flags passed to mount.
FsType string
(string: optional) - The file system type.
MountFlags []string
[]string: optional - The flags passed to mount.
fsType String
(string: optional) - The file system type.
mountFlags List<String>
[]string: optional - The flags passed to mount.
fsType string
(string: optional) - The file system type.
mountFlags string[]
[]string: optional - The flags passed to mount.
fs_type str
(string: optional) - The file system type.
mount_flags Sequence[str]
[]string: optional - The flags passed to mount.
fsType String
(string: optional) - The file system type.
mountFlags List<String>
[]string: optional - The flags passed to mount.

CsiVolumeTopology
, CsiVolumeTopologyArgs

Segments Dictionary<string, string>

(map[string]string) - Define the attributes for the topology request.

In addition to the above arguments, the following attributes are exported and can be referenced:

Segments map[string]string

(map[string]string) - Define the attributes for the topology request.

In addition to the above arguments, the following attributes are exported and can be referenced:

segments Map<String,String>

(map[string]string) - Define the attributes for the topology request.

In addition to the above arguments, the following attributes are exported and can be referenced:

segments {[key: string]: string}

(map[string]string) - Define the attributes for the topology request.

In addition to the above arguments, the following attributes are exported and can be referenced:

segments Mapping[str, str]

(map[string]string) - Define the attributes for the topology request.

In addition to the above arguments, the following attributes are exported and can be referenced:

segments Map<String>

(map[string]string) - Define the attributes for the topology request.

In addition to the above arguments, the following attributes are exported and can be referenced:

CsiVolumeTopologyRequest
, CsiVolumeTopologyRequestArgs

Preferred Changes to this property will trigger replacement. CsiVolumeTopologyRequestPreferred
(``Topology``: <optional>) - Preferred topologies indicate that the volume should be created in a location accessible from some of the listed topologies.
Required Changes to this property will trigger replacement. CsiVolumeTopologyRequestRequired
(``Topology``: <optional>) - Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
Preferred Changes to this property will trigger replacement. CsiVolumeTopologyRequestPreferred
(``Topology``: <optional>) - Preferred topologies indicate that the volume should be created in a location accessible from some of the listed topologies.
Required Changes to this property will trigger replacement. CsiVolumeTopologyRequestRequired
(``Topology``: <optional>) - Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
preferred Changes to this property will trigger replacement. CsiVolumeTopologyRequestPreferred
(``Topology``: <optional>) - Preferred topologies indicate that the volume should be created in a location accessible from some of the listed topologies.
required Changes to this property will trigger replacement. CsiVolumeTopologyRequestRequired
(``Topology``: <optional>) - Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
preferred Changes to this property will trigger replacement. CsiVolumeTopologyRequestPreferred
(``Topology``: <optional>) - Preferred topologies indicate that the volume should be created in a location accessible from some of the listed topologies.
required Changes to this property will trigger replacement. CsiVolumeTopologyRequestRequired
(``Topology``: <optional>) - Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
preferred Changes to this property will trigger replacement. CsiVolumeTopologyRequestPreferred
(``Topology``: <optional>) - Preferred topologies indicate that the volume should be created in a location accessible from some of the listed topologies.
required Changes to this property will trigger replacement. CsiVolumeTopologyRequestRequired
(``Topology``: <optional>) - Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
preferred Changes to this property will trigger replacement. Property Map
(``Topology``: <optional>) - Preferred topologies indicate that the volume should be created in a location accessible from some of the listed topologies.
required Changes to this property will trigger replacement. Property Map
(``Topology``: <optional>) - Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.

CsiVolumeTopologyRequestPreferred
, CsiVolumeTopologyRequestPreferredArgs

Topologies
This property is required.
Changes to this property will trigger replacement.
List<CsiVolumeTopologyRequestPreferredTopology>
Defines the location for the volume.
Topologies
This property is required.
Changes to this property will trigger replacement.
[]CsiVolumeTopologyRequestPreferredTopology
Defines the location for the volume.
topologies
This property is required.
Changes to this property will trigger replacement.
List<CsiVolumeTopologyRequestPreferredTopology>
Defines the location for the volume.
topologies
This property is required.
Changes to this property will trigger replacement.
CsiVolumeTopologyRequestPreferredTopology[]
Defines the location for the volume.
topologies
This property is required.
Changes to this property will trigger replacement.
Sequence[CsiVolumeTopologyRequestPreferredTopology]
Defines the location for the volume.
topologies
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
Defines the location for the volume.

CsiVolumeTopologyRequestPreferredTopology
, CsiVolumeTopologyRequestPreferredTopologyArgs

Segments
This property is required.
Changes to this property will trigger replacement.
Dictionary<string, string>
Define the attributes for the topology request.
Segments
This property is required.
Changes to this property will trigger replacement.
map[string]string
Define the attributes for the topology request.
segments
This property is required.
Changes to this property will trigger replacement.
Map<String,String>
Define the attributes for the topology request.
segments
This property is required.
Changes to this property will trigger replacement.
{[key: string]: string}
Define the attributes for the topology request.
segments
This property is required.
Changes to this property will trigger replacement.
Mapping[str, str]
Define the attributes for the topology request.
segments
This property is required.
Changes to this property will trigger replacement.
Map<String>
Define the attributes for the topology request.

CsiVolumeTopologyRequestRequired
, CsiVolumeTopologyRequestRequiredArgs

Topologies
This property is required.
Changes to this property will trigger replacement.
List<CsiVolumeTopologyRequestRequiredTopology>
Defines the location for the volume.
Topologies
This property is required.
Changes to this property will trigger replacement.
[]CsiVolumeTopologyRequestRequiredTopology
Defines the location for the volume.
topologies
This property is required.
Changes to this property will trigger replacement.
List<CsiVolumeTopologyRequestRequiredTopology>
Defines the location for the volume.
topologies
This property is required.
Changes to this property will trigger replacement.
CsiVolumeTopologyRequestRequiredTopology[]
Defines the location for the volume.
topologies
This property is required.
Changes to this property will trigger replacement.
Sequence[CsiVolumeTopologyRequestRequiredTopology]
Defines the location for the volume.
topologies
This property is required.
Changes to this property will trigger replacement.
List<Property Map>
Defines the location for the volume.

CsiVolumeTopologyRequestRequiredTopology
, CsiVolumeTopologyRequestRequiredTopologyArgs

Segments
This property is required.
Changes to this property will trigger replacement.
Dictionary<string, string>
Define the attributes for the topology request.
Segments
This property is required.
Changes to this property will trigger replacement.
map[string]string
Define the attributes for the topology request.
segments
This property is required.
Changes to this property will trigger replacement.
Map<String,String>
Define the attributes for the topology request.
segments
This property is required.
Changes to this property will trigger replacement.
{[key: string]: string}
Define the attributes for the topology request.
segments
This property is required.
Changes to this property will trigger replacement.
Mapping[str, str]
Define the attributes for the topology request.
segments
This property is required.
Changes to this property will trigger replacement.
Map<String>
Define the attributes for the topology request.

Package Details

Repository
HashiCorp Nomad pulumi/pulumi-nomad
License
Apache-2.0
Notes
This Pulumi package is based on the nomad Terraform Provider.
Nomad v2.5.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-nomad