1. Packages
  2. Nomad Provider
  3. API Docs
  4. DynamicHostVolumeRegistration
Nomad v2.5.0 published on Thursday, Apr 17, 2025 by Pulumi

nomad.DynamicHostVolumeRegistration

Explore with Pulumi AI

nomad logo
Nomad v2.5.0 published on Thursday, Apr 17, 2025 by Pulumi

    Registers a dynamic host volume in Nomad that has already been created. Note that Nomad supports two workflows for dynamic host volumes: create and register. Both resources result in the same data source with the same outputs.

    Create DynamicHostVolumeRegistration Resource

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

    Constructor syntax

    new DynamicHostVolumeRegistration(name: string, args: DynamicHostVolumeRegistrationArgs, opts?: CustomResourceOptions);
    @overload
    def DynamicHostVolumeRegistration(resource_name: str,
                                      args: DynamicHostVolumeRegistrationArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def DynamicHostVolumeRegistration(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      capabilities: Optional[Sequence[DynamicHostVolumeRegistrationCapabilityArgs]] = None,
                                      host_path: Optional[str] = None,
                                      node_id: Optional[str] = None,
                                      capacity: Optional[str] = None,
                                      name: Optional[str] = None,
                                      namespace: Optional[str] = None,
                                      parameters: Optional[Mapping[str, str]] = None)
    func NewDynamicHostVolumeRegistration(ctx *Context, name string, args DynamicHostVolumeRegistrationArgs, opts ...ResourceOption) (*DynamicHostVolumeRegistration, error)
    public DynamicHostVolumeRegistration(string name, DynamicHostVolumeRegistrationArgs args, CustomResourceOptions? opts = null)
    public DynamicHostVolumeRegistration(String name, DynamicHostVolumeRegistrationArgs args)
    public DynamicHostVolumeRegistration(String name, DynamicHostVolumeRegistrationArgs args, CustomResourceOptions options)
    
    type: nomad:DynamicHostVolumeRegistration
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DynamicHostVolumeRegistrationArgs
    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 DynamicHostVolumeRegistrationArgs
    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 DynamicHostVolumeRegistrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DynamicHostVolumeRegistrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DynamicHostVolumeRegistrationArgs
    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 dynamicHostVolumeRegistrationResource = new Nomad.DynamicHostVolumeRegistration("dynamicHostVolumeRegistrationResource", new()
    {
        Capabilities = new[]
        {
            new Nomad.Inputs.DynamicHostVolumeRegistrationCapabilityArgs
            {
                AccessMode = "string",
                AttachmentMode = "string",
            },
        },
        HostPath = "string",
        NodeId = "string",
        Capacity = "string",
        Name = "string",
        Namespace = "string",
        Parameters = 
        {
            { "string", "string" },
        },
    });
    
    example, err := nomad.NewDynamicHostVolumeRegistration(ctx, "dynamicHostVolumeRegistrationResource", &nomad.DynamicHostVolumeRegistrationArgs{
    	Capabilities: nomad.DynamicHostVolumeRegistrationCapabilityArray{
    		&nomad.DynamicHostVolumeRegistrationCapabilityArgs{
    			AccessMode:     pulumi.String("string"),
    			AttachmentMode: pulumi.String("string"),
    		},
    	},
    	HostPath:  pulumi.String("string"),
    	NodeId:    pulumi.String("string"),
    	Capacity:  pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	Namespace: pulumi.String("string"),
    	Parameters: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var dynamicHostVolumeRegistrationResource = new DynamicHostVolumeRegistration("dynamicHostVolumeRegistrationResource", DynamicHostVolumeRegistrationArgs.builder()
        .capabilities(DynamicHostVolumeRegistrationCapabilityArgs.builder()
            .accessMode("string")
            .attachmentMode("string")
            .build())
        .hostPath("string")
        .nodeId("string")
        .capacity("string")
        .name("string")
        .namespace("string")
        .parameters(Map.of("string", "string"))
        .build());
    
    dynamic_host_volume_registration_resource = nomad.DynamicHostVolumeRegistration("dynamicHostVolumeRegistrationResource",
        capabilities=[{
            "access_mode": "string",
            "attachment_mode": "string",
        }],
        host_path="string",
        node_id="string",
        capacity="string",
        name="string",
        namespace="string",
        parameters={
            "string": "string",
        })
    
    const dynamicHostVolumeRegistrationResource = new nomad.DynamicHostVolumeRegistration("dynamicHostVolumeRegistrationResource", {
        capabilities: [{
            accessMode: "string",
            attachmentMode: "string",
        }],
        hostPath: "string",
        nodeId: "string",
        capacity: "string",
        name: "string",
        namespace: "string",
        parameters: {
            string: "string",
        },
    });
    
    type: nomad:DynamicHostVolumeRegistration
    properties:
        capabilities:
            - accessMode: string
              attachmentMode: string
        capacity: string
        hostPath: string
        name: string
        namespace: string
        nodeId: string
        parameters:
            string: string
    

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

    Capabilities List<DynamicHostVolumeRegistrationCapability>
    (block: <optional>) - Option for validating the capability of a volume. Each capability block has the following attributes:
    HostPath string
    (string) - The path on disk where the volume exists.
    NodeId string
    (string: <required>) - A specific node where the volume is mounted.
    Capacity string
    (string: <optional>) - The size of a volume in bytes. Either the physical size of a disk or a quota, depending on the plugin. This field must be between the capacity_min and capacity_max values unless they are omitted. Accepts human-friendly suffixes such as "100GiB".
    Name string
    (string: <required>) - The name of the volume, which is used as the [volume.source][volume_source] field in job specifications that claim this volume. Host volume names must be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.
    Namespace string
    (string: <optional>) - The namespace of the volume. This field overrides the namespace provided by the -namespace flag or NOMAD_NAMESPACE environment variable. Defaults to "default" if unset.
    Parameters Dictionary<string, string>
    (map<string|string>: <optional>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.
    Capabilities []DynamicHostVolumeRegistrationCapabilityArgs
    (block: <optional>) - Option for validating the capability of a volume. Each capability block has the following attributes:
    HostPath string
    (string) - The path on disk where the volume exists.
    NodeId string
    (string: <required>) - A specific node where the volume is mounted.
    Capacity string
    (string: <optional>) - The size of a volume in bytes. Either the physical size of a disk or a quota, depending on the plugin. This field must be between the capacity_min and capacity_max values unless they are omitted. Accepts human-friendly suffixes such as "100GiB".
    Name string
    (string: <required>) - The name of the volume, which is used as the [volume.source][volume_source] field in job specifications that claim this volume. Host volume names must be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.
    Namespace string
    (string: <optional>) - The namespace of the volume. This field overrides the namespace provided by the -namespace flag or NOMAD_NAMESPACE environment variable. Defaults to "default" if unset.
    Parameters map[string]string
    (map<string|string>: <optional>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.
    capabilities List<DynamicHostVolumeRegistrationCapability>
    (block: <optional>) - Option for validating the capability of a volume. Each capability block has the following attributes:
    hostPath String
    (string) - The path on disk where the volume exists.
    nodeId String
    (string: <required>) - A specific node where the volume is mounted.
    capacity String
    (string: <optional>) - The size of a volume in bytes. Either the physical size of a disk or a quota, depending on the plugin. This field must be between the capacity_min and capacity_max values unless they are omitted. Accepts human-friendly suffixes such as "100GiB".
    name String
    (string: <required>) - The name of the volume, which is used as the [volume.source][volume_source] field in job specifications that claim this volume. Host volume names must be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.
    namespace String
    (string: <optional>) - The namespace of the volume. This field overrides the namespace provided by the -namespace flag or NOMAD_NAMESPACE environment variable. Defaults to "default" if unset.
    parameters Map<String,String>
    (map<string|string>: <optional>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.
    capabilities DynamicHostVolumeRegistrationCapability[]
    (block: <optional>) - Option for validating the capability of a volume. Each capability block has the following attributes:
    hostPath string
    (string) - The path on disk where the volume exists.
    nodeId string
    (string: <required>) - A specific node where the volume is mounted.
    capacity string
    (string: <optional>) - The size of a volume in bytes. Either the physical size of a disk or a quota, depending on the plugin. This field must be between the capacity_min and capacity_max values unless they are omitted. Accepts human-friendly suffixes such as "100GiB".
    name string
    (string: <required>) - The name of the volume, which is used as the [volume.source][volume_source] field in job specifications that claim this volume. Host volume names must be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.
    namespace string
    (string: <optional>) - The namespace of the volume. This field overrides the namespace provided by the -namespace flag or NOMAD_NAMESPACE environment variable. Defaults to "default" if unset.
    parameters {[key: string]: string}
    (map<string|string>: <optional>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.
    capabilities Sequence[DynamicHostVolumeRegistrationCapabilityArgs]
    (block: <optional>) - Option for validating the capability of a volume. Each capability block has the following attributes:
    host_path str
    (string) - The path on disk where the volume exists.
    node_id str
    (string: <required>) - A specific node where the volume is mounted.
    capacity str
    (string: <optional>) - The size of a volume in bytes. Either the physical size of a disk or a quota, depending on the plugin. This field must be between the capacity_min and capacity_max values unless they are omitted. Accepts human-friendly suffixes such as "100GiB".
    name str
    (string: <required>) - The name of the volume, which is used as the [volume.source][volume_source] field in job specifications that claim this volume. Host volume names must be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.
    namespace str
    (string: <optional>) - The namespace of the volume. This field overrides the namespace provided by the -namespace flag or NOMAD_NAMESPACE environment variable. Defaults to "default" if unset.
    parameters Mapping[str, str]
    (map<string|string>: <optional>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.
    capabilities List<Property Map>
    (block: <optional>) - Option for validating the capability of a volume. Each capability block has the following attributes:
    hostPath String
    (string) - The path on disk where the volume exists.
    nodeId String
    (string: <required>) - A specific node where the volume is mounted.
    capacity String
    (string: <optional>) - The size of a volume in bytes. Either the physical size of a disk or a quota, depending on the plugin. This field must be between the capacity_min and capacity_max values unless they are omitted. Accepts human-friendly suffixes such as "100GiB".
    name String
    (string: <required>) - The name of the volume, which is used as the [volume.source][volume_source] field in job specifications that claim this volume. Host volume names must be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.
    namespace String
    (string: <optional>) - The namespace of the volume. This field overrides the namespace provided by the -namespace flag or NOMAD_NAMESPACE environment variable. Defaults to "default" if unset.
    parameters Map<String>
    (map<string|string>: <optional>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.

    Outputs

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

    CapacityBytes int
    CapacityMaxBytes int
    CapacityMinBytes int
    Constraints List<DynamicHostVolumeRegistrationConstraint>
    Constraints
    Id string
    The provider-assigned unique ID for this managed resource.
    NodePool string
    Node pool
    PluginId string
    Plugin ID
    State string
    State
    CapacityBytes int
    CapacityMaxBytes int
    CapacityMinBytes int
    Constraints []DynamicHostVolumeRegistrationConstraint
    Constraints
    Id string
    The provider-assigned unique ID for this managed resource.
    NodePool string
    Node pool
    PluginId string
    Plugin ID
    State string
    State
    capacityBytes Integer
    capacityMaxBytes Integer
    capacityMinBytes Integer
    constraints List<DynamicHostVolumeRegistrationConstraint>
    Constraints
    id String
    The provider-assigned unique ID for this managed resource.
    nodePool String
    Node pool
    pluginId String
    Plugin ID
    state String
    State
    capacityBytes number
    capacityMaxBytes number
    capacityMinBytes number
    constraints DynamicHostVolumeRegistrationConstraint[]
    Constraints
    id string
    The provider-assigned unique ID for this managed resource.
    nodePool string
    Node pool
    pluginId string
    Plugin ID
    state string
    State
    capacity_bytes int
    capacity_max_bytes int
    capacity_min_bytes int
    constraints Sequence[DynamicHostVolumeRegistrationConstraint]
    Constraints
    id str
    The provider-assigned unique ID for this managed resource.
    node_pool str
    Node pool
    plugin_id str
    Plugin ID
    state str
    State
    capacityBytes Number
    capacityMaxBytes Number
    capacityMinBytes Number
    constraints List<Property Map>
    Constraints
    id String
    The provider-assigned unique ID for this managed resource.
    nodePool String
    Node pool
    pluginId String
    Plugin ID
    state String
    State

    Look up Existing DynamicHostVolumeRegistration Resource

    Get an existing DynamicHostVolumeRegistration 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?: DynamicHostVolumeRegistrationState, opts?: CustomResourceOptions): DynamicHostVolumeRegistration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            capabilities: Optional[Sequence[DynamicHostVolumeRegistrationCapabilityArgs]] = None,
            capacity: Optional[str] = None,
            capacity_bytes: Optional[int] = None,
            capacity_max_bytes: Optional[int] = None,
            capacity_min_bytes: Optional[int] = None,
            constraints: Optional[Sequence[DynamicHostVolumeRegistrationConstraintArgs]] = None,
            host_path: Optional[str] = None,
            name: Optional[str] = None,
            namespace: Optional[str] = None,
            node_id: Optional[str] = None,
            node_pool: Optional[str] = None,
            parameters: Optional[Mapping[str, str]] = None,
            plugin_id: Optional[str] = None,
            state: Optional[str] = None) -> DynamicHostVolumeRegistration
    func GetDynamicHostVolumeRegistration(ctx *Context, name string, id IDInput, state *DynamicHostVolumeRegistrationState, opts ...ResourceOption) (*DynamicHostVolumeRegistration, error)
    public static DynamicHostVolumeRegistration Get(string name, Input<string> id, DynamicHostVolumeRegistrationState? state, CustomResourceOptions? opts = null)
    public static DynamicHostVolumeRegistration get(String name, Output<String> id, DynamicHostVolumeRegistrationState state, CustomResourceOptions options)
    resources:  _:    type: nomad:DynamicHostVolumeRegistration    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Capabilities List<DynamicHostVolumeRegistrationCapability>
    (block: <optional>) - Option for validating the capability of a volume. Each capability block has the following attributes:
    Capacity string
    (string: <optional>) - The size of a volume in bytes. Either the physical size of a disk or a quota, depending on the plugin. This field must be between the capacity_min and capacity_max values unless they are omitted. Accepts human-friendly suffixes such as "100GiB".
    CapacityBytes int
    CapacityMaxBytes int
    CapacityMinBytes int
    Constraints List<DynamicHostVolumeRegistrationConstraint>
    Constraints
    HostPath string
    (string) - The path on disk where the volume exists.
    Name string
    (string: <required>) - The name of the volume, which is used as the [volume.source][volume_source] field in job specifications that claim this volume. Host volume names must be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.
    Namespace string
    (string: <optional>) - The namespace of the volume. This field overrides the namespace provided by the -namespace flag or NOMAD_NAMESPACE environment variable. Defaults to "default" if unset.
    NodeId string
    (string: <required>) - A specific node where the volume is mounted.
    NodePool string
    Node pool
    Parameters Dictionary<string, string>
    (map<string|string>: <optional>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.
    PluginId string
    Plugin ID
    State string
    State
    Capabilities []DynamicHostVolumeRegistrationCapabilityArgs
    (block: <optional>) - Option for validating the capability of a volume. Each capability block has the following attributes:
    Capacity string
    (string: <optional>) - The size of a volume in bytes. Either the physical size of a disk or a quota, depending on the plugin. This field must be between the capacity_min and capacity_max values unless they are omitted. Accepts human-friendly suffixes such as "100GiB".
    CapacityBytes int
    CapacityMaxBytes int
    CapacityMinBytes int
    Constraints []DynamicHostVolumeRegistrationConstraintArgs
    Constraints
    HostPath string
    (string) - The path on disk where the volume exists.
    Name string
    (string: <required>) - The name of the volume, which is used as the [volume.source][volume_source] field in job specifications that claim this volume. Host volume names must be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.
    Namespace string
    (string: <optional>) - The namespace of the volume. This field overrides the namespace provided by the -namespace flag or NOMAD_NAMESPACE environment variable. Defaults to "default" if unset.
    NodeId string
    (string: <required>) - A specific node where the volume is mounted.
    NodePool string
    Node pool
    Parameters map[string]string
    (map<string|string>: <optional>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.
    PluginId string
    Plugin ID
    State string
    State
    capabilities List<DynamicHostVolumeRegistrationCapability>
    (block: <optional>) - Option for validating the capability of a volume. Each capability block has the following attributes:
    capacity String
    (string: <optional>) - The size of a volume in bytes. Either the physical size of a disk or a quota, depending on the plugin. This field must be between the capacity_min and capacity_max values unless they are omitted. Accepts human-friendly suffixes such as "100GiB".
    capacityBytes Integer
    capacityMaxBytes Integer
    capacityMinBytes Integer
    constraints List<DynamicHostVolumeRegistrationConstraint>
    Constraints
    hostPath String
    (string) - The path on disk where the volume exists.
    name String
    (string: <required>) - The name of the volume, which is used as the [volume.source][volume_source] field in job specifications that claim this volume. Host volume names must be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.
    namespace String
    (string: <optional>) - The namespace of the volume. This field overrides the namespace provided by the -namespace flag or NOMAD_NAMESPACE environment variable. Defaults to "default" if unset.
    nodeId String
    (string: <required>) - A specific node where the volume is mounted.
    nodePool String
    Node pool
    parameters Map<String,String>
    (map<string|string>: <optional>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.
    pluginId String
    Plugin ID
    state String
    State
    capabilities DynamicHostVolumeRegistrationCapability[]
    (block: <optional>) - Option for validating the capability of a volume. Each capability block has the following attributes:
    capacity string
    (string: <optional>) - The size of a volume in bytes. Either the physical size of a disk or a quota, depending on the plugin. This field must be between the capacity_min and capacity_max values unless they are omitted. Accepts human-friendly suffixes such as "100GiB".
    capacityBytes number
    capacityMaxBytes number
    capacityMinBytes number
    constraints DynamicHostVolumeRegistrationConstraint[]
    Constraints
    hostPath string
    (string) - The path on disk where the volume exists.
    name string
    (string: <required>) - The name of the volume, which is used as the [volume.source][volume_source] field in job specifications that claim this volume. Host volume names must be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.
    namespace string
    (string: <optional>) - The namespace of the volume. This field overrides the namespace provided by the -namespace flag or NOMAD_NAMESPACE environment variable. Defaults to "default" if unset.
    nodeId string
    (string: <required>) - A specific node where the volume is mounted.
    nodePool string
    Node pool
    parameters {[key: string]: string}
    (map<string|string>: <optional>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.
    pluginId string
    Plugin ID
    state string
    State
    capabilities Sequence[DynamicHostVolumeRegistrationCapabilityArgs]
    (block: <optional>) - Option for validating the capability of a volume. Each capability block has the following attributes:
    capacity str
    (string: <optional>) - The size of a volume in bytes. Either the physical size of a disk or a quota, depending on the plugin. This field must be between the capacity_min and capacity_max values unless they are omitted. Accepts human-friendly suffixes such as "100GiB".
    capacity_bytes int
    capacity_max_bytes int
    capacity_min_bytes int
    constraints Sequence[DynamicHostVolumeRegistrationConstraintArgs]
    Constraints
    host_path str
    (string) - The path on disk where the volume exists.
    name str
    (string: <required>) - The name of the volume, which is used as the [volume.source][volume_source] field in job specifications that claim this volume. Host volume names must be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.
    namespace str
    (string: <optional>) - The namespace of the volume. This field overrides the namespace provided by the -namespace flag or NOMAD_NAMESPACE environment variable. Defaults to "default" if unset.
    node_id str
    (string: <required>) - A specific node where the volume is mounted.
    node_pool str
    Node pool
    parameters Mapping[str, str]
    (map<string|string>: <optional>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.
    plugin_id str
    Plugin ID
    state str
    State
    capabilities List<Property Map>
    (block: <optional>) - Option for validating the capability of a volume. Each capability block has the following attributes:
    capacity String
    (string: <optional>) - The size of a volume in bytes. Either the physical size of a disk or a quota, depending on the plugin. This field must be between the capacity_min and capacity_max values unless they are omitted. Accepts human-friendly suffixes such as "100GiB".
    capacityBytes Number
    capacityMaxBytes Number
    capacityMinBytes Number
    constraints List<Property Map>
    Constraints
    hostPath String
    (string) - The path on disk where the volume exists.
    name String
    (string: <required>) - The name of the volume, which is used as the [volume.source][volume_source] field in job specifications that claim this volume. Host volume names must be unique per node. Names are visible to any user with node:read ACL, even across namespaces, so they should not be treated as sensitive values.
    namespace String
    (string: <optional>) - The namespace of the volume. This field overrides the namespace provided by the -namespace flag or NOMAD_NAMESPACE environment variable. Defaults to "default" if unset.
    nodeId String
    (string: <required>) - A specific node where the volume is mounted.
    nodePool String
    Node pool
    parameters Map<String>
    (map<string|string>: <optional>) - A key-value map of strings passed directly to the plugin to configure the volume. The details of these parameters are specific to the plugin.
    pluginId String
    Plugin ID
    state String
    State

    Supporting Types

    DynamicHostVolumeRegistrationCapability, DynamicHostVolumeRegistrationCapabilityArgs

    AccessMode string
    (string) - How the volume can be mounted by allocations. Refer to the [access_mode][] documentation for details.
    AttachmentMode string
    (string) - The storage API that will be used by the volume. Refer to the [attachment_mode][] documentation.
    AccessMode string
    (string) - How the volume can be mounted by allocations. Refer to the [access_mode][] documentation for details.
    AttachmentMode string
    (string) - The storage API that will be used by the volume. Refer to the [attachment_mode][] documentation.
    accessMode String
    (string) - How the volume can be mounted by allocations. Refer to the [access_mode][] documentation for details.
    attachmentMode String
    (string) - The storage API that will be used by the volume. Refer to the [attachment_mode][] documentation.
    accessMode string
    (string) - How the volume can be mounted by allocations. Refer to the [access_mode][] documentation for details.
    attachmentMode string
    (string) - The storage API that will be used by the volume. Refer to the [attachment_mode][] documentation.
    access_mode str
    (string) - How the volume can be mounted by allocations. Refer to the [access_mode][] documentation for details.
    attachment_mode str
    (string) - The storage API that will be used by the volume. Refer to the [attachment_mode][] documentation.
    accessMode String
    (string) - How the volume can be mounted by allocations. Refer to the [access_mode][] documentation for details.
    attachmentMode String
    (string) - The storage API that will be used by the volume. Refer to the [attachment_mode][] documentation.

    DynamicHostVolumeRegistrationConstraint, DynamicHostVolumeRegistrationConstraintArgs

    Attribute string
    An attribute to check to constrain volume placement
    Operator string
    The operator to use for comparison
    Value string
    The requested value of the attribute
    Attribute string
    An attribute to check to constrain volume placement
    Operator string
    The operator to use for comparison
    Value string
    The requested value of the attribute
    attribute String
    An attribute to check to constrain volume placement
    operator String
    The operator to use for comparison
    value String
    The requested value of the attribute
    attribute string
    An attribute to check to constrain volume placement
    operator string
    The operator to use for comparison
    value string
    The requested value of the attribute
    attribute str
    An attribute to check to constrain volume placement
    operator str
    The operator to use for comparison
    value str
    The requested value of the attribute
    attribute String
    An attribute to check to constrain volume placement
    operator String
    The operator to use for comparison
    value String
    The requested value of the attribute

    Package Details

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