nomad.CsiVolume
Explore with Pulumi AI
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 string
- The unique name of the resource.
- args CsiVolumeArgs
- 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 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 string
- The unique name of the resource.
- args CsiVolumeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CsiVolumeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
});
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"),
})
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());
csi_volume_resource = nomad.CsiVolume("csiVolumeResource",
capabilities=[nomad.CsiVolumeCapabilityArgs(
access_mode="string",
attachment_mode="string",
)],
volume_id="string",
plugin_id="string",
namespace="string",
mount_options=nomad.CsiVolumeMountOptionsArgs(
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=nomad.CsiVolumeTopologyRequestArgs(
preferred=nomad.CsiVolumeTopologyRequestPreferredArgs(
topologies=[nomad.CsiVolumeTopologyRequestPreferredTopologyArgs(
segments={
"string": "string",
},
)],
),
required=nomad.CsiVolumeTopologyRequestRequiredArgs(
topologies=[nomad.CsiVolumeTopologyRequestRequiredTopologyArgs(
segments={
"string": "string",
},
)],
),
),
capacity_max="string")
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",
});
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
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
The CsiVolume resource accepts the following input properties:
- Capabilities
List<Csi
Volume Capability> (``Capability``: <required>)
- Options for validating the capability of a volume.- Plugin
Id string (string: <required>)
- The ID of the Nomad plugin for registering this volume.- Volume
Id string (string: <required>)
- The unique ID of the volume.- Capacity
Max string (string: <optional>)
- Option to signal a maximum volume size. This may not be supported by all storage providers.- Capacity
Min string (string: <optional>)
- Option to signal a minimum volume size. This may not be supported by all storage providers.- Clone
Id string (string: <optional>)
- The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts withsnapshot_id
.- Mount
Options CsiVolume Mount Options (block: optional)
Options for mountingblock-device
volumes without a pre-formatted file system.- Name string
(string: <required>)
- The display name for the volume.- Namespace 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.- Snapshot
Id string (string: <optional>)
- The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts withclone_id
.- Topology
Request CsiVolume Topology Request (``TopologyRequest``: <optional>)
- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
- Capabilities
[]Csi
Volume Capability Args (``Capability``: <required>)
- Options for validating the capability of a volume.- Plugin
Id string (string: <required>)
- The ID of the Nomad plugin for registering this volume.- Volume
Id string (string: <required>)
- The unique ID of the volume.- Capacity
Max string (string: <optional>)
- Option to signal a maximum volume size. This may not be supported by all storage providers.- Capacity
Min string (string: <optional>)
- Option to signal a minimum volume size. This may not be supported by all storage providers.- Clone
Id string (string: <optional>)
- The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts withsnapshot_id
.- Mount
Options CsiVolume Mount Options Args (block: optional)
Options for mountingblock-device
volumes without a pre-formatted file system.- Name string
(string: <required>)
- The display name for the volume.- Namespace 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.- Snapshot
Id string (string: <optional>)
- The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts withclone_id
.- Topology
Request CsiVolume Topology Request Args (``TopologyRequest``: <optional>)
- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
- capabilities
List<Csi
Volume Capability> (``Capability``: <required>)
- Options for validating the capability of a volume.- plugin
Id String (string: <required>)
- The ID of the Nomad plugin for registering this volume.- volume
Id String (string: <required>)
- The unique ID of the volume.- capacity
Max String (string: <optional>)
- Option to signal a maximum volume size. This may not be supported by all storage providers.- capacity
Min String (string: <optional>)
- Option to signal a minimum volume size. This may not be supported by all storage providers.- clone
Id String (string: <optional>)
- The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts withsnapshot_id
.- mount
Options CsiVolume Mount Options (block: optional)
Options for mountingblock-device
volumes without a pre-formatted file system.- name String
(string: <required>)
- The display name for the volume.- namespace 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.- snapshot
Id String (string: <optional>)
- The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts withclone_id
.- topology
Request CsiVolume Topology Request (``TopologyRequest``: <optional>)
- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
- capabilities
Csi
Volume Capability[] (``Capability``: <required>)
- Options for validating the capability of a volume.- plugin
Id string (string: <required>)
- The ID of the Nomad plugin for registering this volume.- volume
Id string (string: <required>)
- The unique ID of the volume.- capacity
Max string (string: <optional>)
- Option to signal a maximum volume size. This may not be supported by all storage providers.- capacity
Min string (string: <optional>)
- Option to signal a minimum volume size. This may not be supported by all storage providers.- clone
Id string (string: <optional>)
- The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts withsnapshot_id
.- mount
Options CsiVolume Mount Options (block: optional)
Options for mountingblock-device
volumes without a pre-formatted file system.- name string
(string: <required>)
- The display name for the volume.- namespace 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.- snapshot
Id string (string: <optional>)
- The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts withclone_id
.- topology
Request CsiVolume Topology Request (``TopologyRequest``: <optional>)
- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
- capabilities
Sequence[Csi
Volume Capability Args] (``Capability``: <required>)
- Options for validating the capability of a volume.- plugin_
id str (string: <required>)
- The ID of the Nomad plugin for registering this volume.- volume_
id 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 str (string: <optional>)
- The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts withsnapshot_id
.- mount_
options CsiVolume Mount Options Args (block: optional)
Options for mountingblock-device
volumes without a pre-formatted file system.- name str
(string: <required>)
- The display name for the volume.- namespace 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 str (string: <optional>)
- The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts withclone_id
.- topology_
request CsiVolume Topology Request Args (``TopologyRequest``: <optional>)
- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
- capabilities List<Property Map>
(``Capability``: <required>)
- Options for validating the capability of a volume.- plugin
Id String (string: <required>)
- The ID of the Nomad plugin for registering this volume.- volume
Id String (string: <required>)
- The unique ID of the volume.- capacity
Max String (string: <optional>)
- Option to signal a maximum volume size. This may not be supported by all storage providers.- capacity
Min String (string: <optional>)
- Option to signal a minimum volume size. This may not be supported by all storage providers.- clone
Id String (string: <optional>)
- The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts withsnapshot_id
.- mount
Options Property Map (block: optional)
Options for mountingblock-device
volumes without a pre-formatted file system.- name String
(string: <required>)
- The display name for the volume.- namespace 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.- snapshot
Id String (string: <optional>)
- The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts withclone_id
.- topology
Request 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
- Capacity
Max intBytes - Capacity
Min intBytes - Controller
Required bool - Controllers
Expected int - Controllers
Healthy int - External
Id string - The ID of the physical volume from the storage provider.
- Id string
- The provider-assigned unique ID for this managed resource.
- Nodes
Expected int - Nodes
Healthy int - Plugin
Provider string - Plugin
Provider stringVersion - Schedulable bool
- Topologies
List<Csi
Volume Topology>
- Capacity int
- Capacity
Max intBytes - Capacity
Min intBytes - Controller
Required bool - Controllers
Expected int - Controllers
Healthy int - External
Id string - The ID of the physical volume from the storage provider.
- Id string
- The provider-assigned unique ID for this managed resource.
- Nodes
Expected int - Nodes
Healthy int - Plugin
Provider string - Plugin
Provider stringVersion - Schedulable bool
- Topologies
[]Csi
Volume Topology
- capacity Integer
- capacity
Max IntegerBytes - capacity
Min IntegerBytes - controller
Required Boolean - controllers
Expected Integer - controllers
Healthy Integer - external
Id String - The ID of the physical volume from the storage provider.
- id String
- The provider-assigned unique ID for this managed resource.
- nodes
Expected Integer - nodes
Healthy Integer - plugin
Provider String - plugin
Provider StringVersion - schedulable Boolean
- topologies
List<Csi
Volume Topology>
- capacity number
- capacity
Max numberBytes - capacity
Min numberBytes - controller
Required boolean - controllers
Expected number - controllers
Healthy number - external
Id string - The ID of the physical volume from the storage provider.
- id string
- The provider-assigned unique ID for this managed resource.
- nodes
Expected number - nodes
Healthy number - plugin
Provider string - plugin
Provider stringVersion - schedulable boolean
- topologies
Csi
Volume Topology[]
- capacity int
- capacity_
max_ intbytes - capacity_
min_ intbytes - 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_ strversion - schedulable bool
- topologies
Sequence[Csi
Volume Topology]
- capacity Number
- capacity
Max NumberBytes - capacity
Min NumberBytes - controller
Required Boolean - controllers
Expected Number - controllers
Healthy Number - external
Id String - The ID of the physical volume from the storage provider.
- id String
- The provider-assigned unique ID for this managed resource.
- nodes
Expected Number - nodes
Healthy Number - plugin
Provider String - plugin
Provider StringVersion - 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,
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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Capabilities
List<Csi
Volume Capability> (``Capability``: <required>)
- Options for validating the capability of a volume.- Capacity int
- Capacity
Max string (string: <optional>)
- Option to signal a maximum volume size. This may not be supported by all storage providers.- Capacity
Max intBytes - Capacity
Min string (string: <optional>)
- Option to signal a minimum volume size. This may not be supported by all storage providers.- Capacity
Min intBytes - Clone
Id string (string: <optional>)
- The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts withsnapshot_id
.- Controller
Required bool - Controllers
Expected int - Controllers
Healthy int - External
Id string - The ID of the physical volume from the storage provider.
- Mount
Options CsiVolume Mount Options (block: optional)
Options for mountingblock-device
volumes without a pre-formatted file system.- Name string
(string: <required>)
- The display name for the volume.- Namespace string
(string: "default")
- The namespace in which to register the volume.- Nodes
Expected int - Nodes
Healthy 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.- Plugin
Id string (string: <required>)
- The ID of the Nomad plugin for registering this volume.- Plugin
Provider string - Plugin
Provider stringVersion - 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.- Snapshot
Id string (string: <optional>)
- The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts withclone_id
.- Topologies
List<Csi
Volume Topology> - Topology
Request CsiVolume Topology Request (``TopologyRequest``: <optional>)
- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.- Volume
Id string (string: <required>)
- The unique ID of the volume.
- Capabilities
[]Csi
Volume Capability Args (``Capability``: <required>)
- Options for validating the capability of a volume.- Capacity int
- Capacity
Max string (string: <optional>)
- Option to signal a maximum volume size. This may not be supported by all storage providers.- Capacity
Max intBytes - Capacity
Min string (string: <optional>)
- Option to signal a minimum volume size. This may not be supported by all storage providers.- Capacity
Min intBytes - Clone
Id string (string: <optional>)
- The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts withsnapshot_id
.- Controller
Required bool - Controllers
Expected int - Controllers
Healthy int - External
Id string - The ID of the physical volume from the storage provider.
- Mount
Options CsiVolume Mount Options Args (block: optional)
Options for mountingblock-device
volumes without a pre-formatted file system.- Name string
(string: <required>)
- The display name for the volume.- Namespace string
(string: "default")
- The namespace in which to register the volume.- Nodes
Expected int - Nodes
Healthy 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.- Plugin
Id string (string: <required>)
- The ID of the Nomad plugin for registering this volume.- Plugin
Provider string - Plugin
Provider stringVersion - 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.- Snapshot
Id string (string: <optional>)
- The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts withclone_id
.- Topologies
[]Csi
Volume Topology Args - Topology
Request CsiVolume Topology Request Args (``TopologyRequest``: <optional>)
- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.- Volume
Id string (string: <required>)
- The unique ID of the volume.
- capabilities
List<Csi
Volume Capability> (``Capability``: <required>)
- Options for validating the capability of a volume.- capacity Integer
- capacity
Max String (string: <optional>)
- Option to signal a maximum volume size. This may not be supported by all storage providers.- capacity
Max IntegerBytes - capacity
Min String (string: <optional>)
- Option to signal a minimum volume size. This may not be supported by all storage providers.- capacity
Min IntegerBytes - clone
Id String (string: <optional>)
- The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts withsnapshot_id
.- controller
Required Boolean - controllers
Expected Integer - controllers
Healthy Integer - external
Id String - The ID of the physical volume from the storage provider.
- mount
Options CsiVolume Mount Options (block: optional)
Options for mountingblock-device
volumes without a pre-formatted file system.- name String
(string: <required>)
- The display name for the volume.- namespace String
(string: "default")
- The namespace in which to register the volume.- nodes
Expected Integer - nodes
Healthy 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.- plugin
Id String (string: <required>)
- The ID of the Nomad plugin for registering this volume.- plugin
Provider String - plugin
Provider StringVersion - 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.- snapshot
Id String (string: <optional>)
- The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts withclone_id
.- topologies
List<Csi
Volume Topology> - topology
Request CsiVolume Topology Request (``TopologyRequest``: <optional>)
- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.- volume
Id String (string: <required>)
- The unique ID of the volume.
- capabilities
Csi
Volume Capability[] (``Capability``: <required>)
- Options for validating the capability of a volume.- capacity number
- capacity
Max string (string: <optional>)
- Option to signal a maximum volume size. This may not be supported by all storage providers.- capacity
Max numberBytes - capacity
Min string (string: <optional>)
- Option to signal a minimum volume size. This may not be supported by all storage providers.- capacity
Min numberBytes - clone
Id string (string: <optional>)
- The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts withsnapshot_id
.- controller
Required boolean - controllers
Expected number - controllers
Healthy number - external
Id string - The ID of the physical volume from the storage provider.
- mount
Options CsiVolume Mount Options (block: optional)
Options for mountingblock-device
volumes without a pre-formatted file system.- name string
(string: <required>)
- The display name for the volume.- namespace string
(string: "default")
- The namespace in which to register the volume.- nodes
Expected number - nodes
Healthy 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.- plugin
Id string (string: <required>)
- The ID of the Nomad plugin for registering this volume.- plugin
Provider string - plugin
Provider stringVersion - 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.- snapshot
Id string (string: <optional>)
- The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts withclone_id
.- topologies
Csi
Volume Topology[] - topology
Request CsiVolume Topology Request (``TopologyRequest``: <optional>)
- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.- volume
Id string (string: <required>)
- The unique ID of the volume.
- capabilities
Sequence[Csi
Volume Capability Args] (``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_ intbytes - capacity_
min str (string: <optional>)
- Option to signal a minimum volume size. This may not be supported by all storage providers.- capacity_
min_ intbytes - clone_
id str (string: <optional>)
- The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts withsnapshot_id
.- controller_
required bool - controllers_
expected int - controllers_
healthy int - external_
id str - The ID of the physical volume from the storage provider.
- mount_
options CsiVolume Mount Options Args (block: optional)
Options for mountingblock-device
volumes without a pre-formatted file system.- name str
(string: <required>)
- The display name for the volume.- namespace 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 str (string: <required>)
- The ID of the Nomad plugin for registering this volume.- plugin_
provider str - plugin_
provider_ strversion - 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 str (string: <optional>)
- The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts withclone_id
.- topologies
Sequence[Csi
Volume Topology Args] - topology_
request CsiVolume Topology Request Args (``TopologyRequest``: <optional>)
- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.- volume_
id str (string: <required>)
- The unique ID of the volume.
- capabilities List<Property Map>
(``Capability``: <required>)
- Options for validating the capability of a volume.- capacity Number
- capacity
Max String (string: <optional>)
- Option to signal a maximum volume size. This may not be supported by all storage providers.- capacity
Max NumberBytes - capacity
Min String (string: <optional>)
- Option to signal a minimum volume size. This may not be supported by all storage providers.- capacity
Min NumberBytes - clone
Id String (string: <optional>)
- The external ID of an existing volume to restore. If ommited, the volume will be created from scratch. Conflicts withsnapshot_id
.- controller
Required Boolean - controllers
Expected Number - controllers
Healthy Number - external
Id String - The ID of the physical volume from the storage provider.
- mount
Options Property Map (block: optional)
Options for mountingblock-device
volumes without a pre-formatted file system.- name String
(string: <required>)
- The display name for the volume.- namespace String
(string: "default")
- The namespace in which to register the volume.- nodes
Expected Number - nodes
Healthy 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.- plugin
Id String (string: <required>)
- The ID of the Nomad plugin for registering this volume.- plugin
Provider String - plugin
Provider StringVersion - schedulable Boolean
- secrets Map<String>
(map[string]string: optional)
An optional key-value map of strings used as credentials for publishing and unpublishing volumes.- snapshot
Id String (string: <optional>)
- The external ID of a snapshot to restore. If ommited, the volume will be created from scratch. Conflicts withclone_id
.- topologies List<Property Map>
- topology
Request Property Map (``TopologyRequest``: <optional>)
- Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.- volume
Id String (string: <required>)
- The unique ID of the volume.
Supporting Types
CsiVolumeCapability, CsiVolumeCapabilityArgs
- Access
Mode 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
- Attachment
Mode string (string: <required>)
- The storage API that will be used by the volume. Possible values are:block-device
file-system
- Access
Mode 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
- Attachment
Mode string (string: <required>)
- The storage API that will be used by the volume. Possible values are:block-device
file-system
- access
Mode 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
- attachment
Mode String (string: <required>)
- The storage API that will be used by the volume. Possible values are:block-device
file-system
- access
Mode 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
- attachment
Mode string (string: <required>)
- The storage API that will be used by the volume. Possible values are:block-device
file-system
- access_
mode 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 str (string: <required>)
- The storage API that will be used by the volume. Possible values are:block-device
file-system
- access
Mode 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
- attachment
Mode String (string: <required>)
- The storage API that will be used by the volume. Possible values are:block-device
file-system
CsiVolumeMountOptions, CsiVolumeMountOptionsArgs
- Fs
Type string (string: optional)
- The file system type.- Mount
Flags List<string> []string: optional
- The flags passed tomount
.
- Fs
Type string (string: optional)
- The file system type.- Mount
Flags []string []string: optional
- The flags passed tomount
.
- fs
Type String (string: optional)
- The file system type.- mount
Flags List<String> []string: optional
- The flags passed tomount
.
- fs
Type string (string: optional)
- The file system type.- mount
Flags string[] []string: optional
- The flags passed tomount
.
- fs_
type str (string: optional)
- The file system type.- mount_
flags Sequence[str] []string: optional
- The flags passed tomount
.
- fs
Type String (string: optional)
- The file system type.- mount
Flags List<String> []string: optional
- The flags passed tomount
.
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
Csi
Volume Topology Request Preferred (``Topology``: <optional>)
- Preferred topologies indicate that the volume should be created in a location accessible from some of the listed topologies.- Required
Csi
Volume Topology Request Required (``Topology``: <optional>)
- Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
- Preferred
Csi
Volume Topology Request Preferred (``Topology``: <optional>)
- Preferred topologies indicate that the volume should be created in a location accessible from some of the listed topologies.- Required
Csi
Volume Topology Request Required (``Topology``: <optional>)
- Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
- preferred
Csi
Volume Topology Request Preferred (``Topology``: <optional>)
- Preferred topologies indicate that the volume should be created in a location accessible from some of the listed topologies.- required
Csi
Volume Topology Request Required (``Topology``: <optional>)
- Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
- preferred
Csi
Volume Topology Request Preferred (``Topology``: <optional>)
- Preferred topologies indicate that the volume should be created in a location accessible from some of the listed topologies.- required
Csi
Volume Topology Request Required (``Topology``: <optional>)
- Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
- preferred
Csi
Volume Topology Request Preferred (``Topology``: <optional>)
- Preferred topologies indicate that the volume should be created in a location accessible from some of the listed topologies.- required
Csi
Volume Topology Request Required (``Topology``: <optional>)
- Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
- preferred Property Map
(``Topology``: <optional>)
- Preferred topologies indicate that the volume should be created in a location accessible from some of the listed topologies.- required 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
List<Csi
Volume Topology Request Preferred Topology> - Defines the location for the volume.
- Topologies
[]Csi
Volume Topology Request Preferred Topology - Defines the location for the volume.
- topologies
List<Csi
Volume Topology Request Preferred Topology> - Defines the location for the volume.
- topologies
Csi
Volume Topology Request Preferred Topology[] - Defines the location for the volume.
- topologies
Sequence[Csi
Volume Topology Request Preferred Topology] - Defines the location for the volume.
- topologies List<Property Map>
- Defines the location for the volume.
CsiVolumeTopologyRequestPreferredTopology, CsiVolumeTopologyRequestPreferredTopologyArgs
- Segments Dictionary<string, string>
- Define the attributes for the topology request.
- Segments map[string]string
- Define the attributes for the topology request.
- segments Map<String,String>
- Define the attributes for the topology request.
- segments {[key: string]: string}
- Define the attributes for the topology request.
- segments Mapping[str, str]
- Define the attributes for the topology request.
- segments Map<String>
- Define the attributes for the topology request.
CsiVolumeTopologyRequestRequired, CsiVolumeTopologyRequestRequiredArgs
- Topologies
List<Csi
Volume Topology Request Required Topology> - Defines the location for the volume.
- Topologies
[]Csi
Volume Topology Request Required Topology - Defines the location for the volume.
- topologies
List<Csi
Volume Topology Request Required Topology> - Defines the location for the volume.
- topologies
Csi
Volume Topology Request Required Topology[] - Defines the location for the volume.
- topologies
Sequence[Csi
Volume Topology Request Required Topology] - Defines the location for the volume.
- topologies List<Property Map>
- Defines the location for the volume.
CsiVolumeTopologyRequestRequiredTopology, CsiVolumeTopologyRequestRequiredTopologyArgs
- Segments Dictionary<string, string>
- Define the attributes for the topology request.
- Segments map[string]string
- Define the attributes for the topology request.
- segments Map<String,String>
- Define the attributes for the topology request.
- segments {[key: string]: string}
- Define the attributes for the topology request.
- segments Mapping[str, str]
- Define the attributes for the topology request.
- segments 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.