Docs Packages
  1. Packages
  2. HashiCorp Nomad
  3. API Docs
  4. CsiVolumeRegistration
Nomad v2.2.0 published on Wednesday, Mar 13, 2024 by Pulumi
pulumi/pulumi-nomad

nomad.CsiVolumeRegistration

Explore with Pulumi AI

nomad logo
Nomad v2.2.0 published on Wednesday, Mar 13, 2024 by Pulumi
pulumi/pulumi-nomad

    Create CsiVolumeRegistration Resource

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

    Constructor syntax

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

@overload
def CsiVolumeRegistration(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          external_id: Optional[str] = None,
                          volume_id: Optional[str] = None,
                          plugin_id: Optional[str] = None,
                          mount_options: Optional[CsiVolumeRegistrationMountOptionsArgs] = None,
                          deregister_on_destroy: Optional[bool] = None,
                          context: Optional[Mapping[str, str]] = None,
                          capabilities: Optional[Sequence[CsiVolumeRegistrationCapabilityArgs]] = None,
                          name: Optional[str] = None,
                          namespace: Optional[str] = None,
                          parameters: Optional[Mapping[str, str]] = None,
                          capacity_min: Optional[str] = None,
                          secrets: Optional[Mapping[str, str]] = None,
                          topology_request: Optional[CsiVolumeRegistrationTopologyRequestArgs] = None,
                          capacity_max: Optional[str] = None)
    func NewCsiVolumeRegistration(ctx *Context, name string, args CsiVolumeRegistrationArgs, opts ...ResourceOption) (*CsiVolumeRegistration, error)
    public CsiVolumeRegistration(string name, CsiVolumeRegistrationArgs args, CustomResourceOptions? opts = null)
    public CsiVolumeRegistration(String name, CsiVolumeRegistrationArgs args)
public CsiVolumeRegistration(String name, CsiVolumeRegistrationArgs args, CustomResourceOptions options)

    type: nomad:CsiVolumeRegistration
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 CsiVolumeRegistrationArgs
    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 CsiVolumeRegistrationArgs
    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 CsiVolumeRegistrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CsiVolumeRegistrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CsiVolumeRegistrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var csiVolumeRegistrationResource = new Nomad.CsiVolumeRegistration("csiVolumeRegistrationResource", new()
{
    ExternalId = "string",
    VolumeId = "string",
    PluginId = "string",
    MountOptions = new Nomad.Inputs.CsiVolumeRegistrationMountOptionsArgs
    {
        FsType = "string",
        MountFlags = new[]
        {
            "string",
        },
    },
    DeregisterOnDestroy = false,
    Context = 
    {
        { "string", "string" },
    },
    Capabilities = new[]
    {
        new Nomad.Inputs.CsiVolumeRegistrationCapabilityArgs
        {
            AccessMode = "string",
            AttachmentMode = "string",
        },
    },
    Name = "string",
    Namespace = "string",
    Parameters = 
    {
        { "string", "string" },
    },
    CapacityMin = "string",
    Secrets = 
    {
        { "string", "string" },
    },
    TopologyRequest = new Nomad.Inputs.CsiVolumeRegistrationTopologyRequestArgs
    {
        Required = new Nomad.Inputs.CsiVolumeRegistrationTopologyRequestRequiredArgs
        {
            Topologies = new[]
            {
                new Nomad.Inputs.CsiVolumeRegistrationTopologyRequestRequiredTopologyArgs
                {
                    Segments = 
                    {
                        { "string", "string" },
                    },
                },
            },
        },
    },
    CapacityMax = "string",
});

    example, err := nomad.NewCsiVolumeRegistration(ctx, "csiVolumeRegistrationResource", &nomad.CsiVolumeRegistrationArgs{
	ExternalId: pulumi.String("string"),
	VolumeId:   pulumi.String("string"),
	PluginId:   pulumi.String("string"),
	MountOptions: &nomad.CsiVolumeRegistrationMountOptionsArgs{
		FsType: pulumi.String("string"),
		MountFlags: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	DeregisterOnDestroy: pulumi.Bool(false),
	Context: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Capabilities: nomad.CsiVolumeRegistrationCapabilityArray{
		&nomad.CsiVolumeRegistrationCapabilityArgs{
			AccessMode:     pulumi.String("string"),
			AttachmentMode: pulumi.String("string"),
		},
	},
	Name:      pulumi.String("string"),
	Namespace: pulumi.String("string"),
	Parameters: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	CapacityMin: pulumi.String("string"),
	Secrets: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	TopologyRequest: &nomad.CsiVolumeRegistrationTopologyRequestArgs{
		Required: &nomad.CsiVolumeRegistrationTopologyRequestRequiredArgs{
			Topologies: nomad.CsiVolumeRegistrationTopologyRequestRequiredTopologyArray{
				&nomad.CsiVolumeRegistrationTopologyRequestRequiredTopologyArgs{
					Segments: pulumi.StringMap{
						"string": pulumi.String("string"),
					},
				},
			},
		},
	},
	CapacityMax: pulumi.String("string"),
})

    var csiVolumeRegistrationResource = new CsiVolumeRegistration("csiVolumeRegistrationResource", CsiVolumeRegistrationArgs.builder()        
    .externalId("string")
    .volumeId("string")
    .pluginId("string")
    .mountOptions(CsiVolumeRegistrationMountOptionsArgs.builder()
        .fsType("string")
        .mountFlags("string")
        .build())
    .deregisterOnDestroy(false)
    .context(Map.of("string", "string"))
    .capabilities(CsiVolumeRegistrationCapabilityArgs.builder()
        .accessMode("string")
        .attachmentMode("string")
        .build())
    .name("string")
    .namespace("string")
    .parameters(Map.of("string", "string"))
    .capacityMin("string")
    .secrets(Map.of("string", "string"))
    .topologyRequest(CsiVolumeRegistrationTopologyRequestArgs.builder()
        .required(CsiVolumeRegistrationTopologyRequestRequiredArgs.builder()
            .topologies(CsiVolumeRegistrationTopologyRequestRequiredTopologyArgs.builder()
                .segments(Map.of("string", "string"))
                .build())
            .build())
        .build())
    .capacityMax("string")
    .build());

    csi_volume_registration_resource = nomad.CsiVolumeRegistration("csiVolumeRegistrationResource",
    external_id="string",
    volume_id="string",
    plugin_id="string",
    mount_options=nomad.CsiVolumeRegistrationMountOptionsArgs(
        fs_type="string",
        mount_flags=["string"],
    ),
    deregister_on_destroy=False,
    context={
        "string": "string",
    },
    capabilities=[nomad.CsiVolumeRegistrationCapabilityArgs(
        access_mode="string",
        attachment_mode="string",
    )],
    name="string",
    namespace="string",
    parameters={
        "string": "string",
    },
    capacity_min="string",
    secrets={
        "string": "string",
    },
    topology_request=nomad.CsiVolumeRegistrationTopologyRequestArgs(
        required=nomad.CsiVolumeRegistrationTopologyRequestRequiredArgs(
            topologies=[nomad.CsiVolumeRegistrationTopologyRequestRequiredTopologyArgs(
                segments={
                    "string": "string",
                },
            )],
        ),
    ),
    capacity_max="string")

    const csiVolumeRegistrationResource = new nomad.CsiVolumeRegistration("csiVolumeRegistrationResource", {
    externalId: "string",
    volumeId: "string",
    pluginId: "string",
    mountOptions: {
        fsType: "string",
        mountFlags: ["string"],
    },
    deregisterOnDestroy: false,
    context: {
        string: "string",
    },
    capabilities: [{
        accessMode: "string",
        attachmentMode: "string",
    }],
    name: "string",
    namespace: "string",
    parameters: {
        string: "string",
    },
    capacityMin: "string",
    secrets: {
        string: "string",
    },
    topologyRequest: {
        required: {
            topologies: [{
                segments: {
                    string: "string",
                },
            }],
        },
    },
    capacityMax: "string",
});

    type: nomad:CsiVolumeRegistration
properties:
    capabilities:
        - accessMode: string
          attachmentMode: string
    capacityMax: string
    capacityMin: string
    context:
        string: string
    deregisterOnDestroy: false
    externalId: string
    mountOptions:
        fsType: string
        mountFlags:
            - string
    name: string
    namespace: string
    parameters:
        string: string
    pluginId: string
    secrets:
        string: string
    topologyRequest:
        required:
            topologies:
                - segments:
                    string: string
    volumeId: string

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

    ExternalId string
    (string: <required>) - The ID of the physical volume from the storage provider.
    PluginId string
    (string: <required>) - The ID of the Nomad plugin for registering this volume.
    VolumeId string
    (string: <required>) - The unique ID of the volume.
    Capabilities List<CsiVolumeRegistrationCapability>
    (``Capability``: <required>) - Options for validating the capability of a 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.
    Context Dictionary<string, string>
    (map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.
    DeregisterOnDestroy bool
    (boolean: true) - If true, the volume will be deregistered on destroy.
    MountOptions CsiVolumeRegistrationMountOptions
    (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 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.
    TopologyRequest CsiVolumeRegistrationTopologyRequest
    (``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
    ExternalId string
    (string: <required>) - The ID of the physical volume from the storage provider.
    PluginId string
    (string: <required>) - The ID of the Nomad plugin for registering this volume.
    VolumeId string
    (string: <required>) - The unique ID of the volume.
    Capabilities []CsiVolumeRegistrationCapabilityArgs
    (``Capability``: <required>) - Options for validating the capability of a 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.
    Context map[string]string
    (map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.
    DeregisterOnDestroy bool
    (boolean: true) - If true, the volume will be deregistered on destroy.
    MountOptions CsiVolumeRegistrationMountOptionsArgs
    (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 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.
    TopologyRequest CsiVolumeRegistrationTopologyRequestArgs
    (``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
    externalId String
    (string: <required>) - The ID of the physical volume from the storage provider.
    pluginId String
    (string: <required>) - The ID of the Nomad plugin for registering this volume.
    volumeId String
    (string: <required>) - The unique ID of the volume.
    capabilities List<CsiVolumeRegistrationCapability>
    (``Capability``: <required>) - Options for validating the capability of a 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.
    context Map<String,String>
    (map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.
    deregisterOnDestroy Boolean
    (boolean: true) - If true, the volume will be deregistered on destroy.
    mountOptions CsiVolumeRegistrationMountOptions
    (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 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.
    topologyRequest CsiVolumeRegistrationTopologyRequest
    (``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
    externalId string
    (string: <required>) - The ID of the physical volume from the storage provider.
    pluginId string
    (string: <required>) - The ID of the Nomad plugin for registering this volume.
    volumeId string
    (string: <required>) - The unique ID of the volume.
    capabilities CsiVolumeRegistrationCapability[]
    (``Capability``: <required>) - Options for validating the capability of a 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.
    context {[key: string]: string}
    (map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.
    deregisterOnDestroy boolean
    (boolean: true) - If true, the volume will be deregistered on destroy.
    mountOptions CsiVolumeRegistrationMountOptions
    (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 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.
    topologyRequest CsiVolumeRegistrationTopologyRequest
    (``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
    external_id str
    (string: <required>) - The ID of the physical volume from the storage provider.
    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.
    capabilities Sequence[CsiVolumeRegistrationCapabilityArgs]
    (``Capability``: <required>) - Options for validating the capability of a 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.
    context Mapping[str, str]
    (map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.
    deregister_on_destroy bool
    (boolean: true) - If true, the volume will be deregistered on destroy.
    mount_options CsiVolumeRegistrationMountOptionsArgs
    (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 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.
    topology_request CsiVolumeRegistrationTopologyRequestArgs
    (``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
    externalId String
    (string: <required>) - The ID of the physical volume from the storage provider.
    pluginId String
    (string: <required>) - The ID of the Nomad plugin for registering this volume.
    volumeId String
    (string: <required>) - The unique ID of the volume.
    capabilities List<Property Map>
    (``Capability``: <required>) - Options for validating the capability of a 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.
    context Map<String>
    (map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.
    deregisterOnDestroy Boolean
    (boolean: true) - If true, the volume will be deregistered on destroy.
    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 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.
    topologyRequest 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 CsiVolumeRegistration resource produces the following output properties:

    Capacity int
    CapacityMaxBytes int
    CapacityMinBytes int
    ControllerRequired bool
    (boolean)
    ControllersExpected int
    (integer)
    ControllersHealthy int
    (integer)
    Id string
    The provider-assigned unique ID for this managed resource.
    NodesExpected int
    (integer)
    NodesHealthy int
    (integer)
    PluginProvider string
    (string)
    PluginProviderVersion string
    (string)
    Schedulable bool
    (boolean)
    Topologies List<CsiVolumeRegistrationTopology>
    (List of topologies)
    Capacity int
    CapacityMaxBytes int
    CapacityMinBytes int
    ControllerRequired bool
    (boolean)
    ControllersExpected int
    (integer)
    ControllersHealthy int
    (integer)
    Id string
    The provider-assigned unique ID for this managed resource.
    NodesExpected int
    (integer)
    NodesHealthy int
    (integer)
    PluginProvider string
    (string)
    PluginProviderVersion string
    (string)
    Schedulable bool
    (boolean)
    Topologies []CsiVolumeRegistrationTopology
    (List of topologies)
    capacity Integer
    capacityMaxBytes Integer
    capacityMinBytes Integer
    controllerRequired Boolean
    (boolean)
    controllersExpected Integer
    (integer)
    controllersHealthy Integer
    (integer)
    id String
    The provider-assigned unique ID for this managed resource.
    nodesExpected Integer
    (integer)
    nodesHealthy Integer
    (integer)
    pluginProvider String
    (string)
    pluginProviderVersion String
    (string)
    schedulable Boolean
    (boolean)
    topologies List<CsiVolumeRegistrationTopology>
    (List of topologies)
    capacity number
    capacityMaxBytes number
    capacityMinBytes number
    controllerRequired boolean
    (boolean)
    controllersExpected number
    (integer)
    controllersHealthy number
    (integer)
    id string
    The provider-assigned unique ID for this managed resource.
    nodesExpected number
    (integer)
    nodesHealthy number
    (integer)
    pluginProvider string
    (string)
    pluginProviderVersion string
    (string)
    schedulable boolean
    (boolean)
    topologies CsiVolumeRegistrationTopology[]
    (List of topologies)
    capacity int
    capacity_max_bytes int
    capacity_min_bytes int
    controller_required bool
    (boolean)
    controllers_expected int
    (integer)
    controllers_healthy int
    (integer)
    id str
    The provider-assigned unique ID for this managed resource.
    nodes_expected int
    (integer)
    nodes_healthy int
    (integer)
    plugin_provider str
    (string)
    plugin_provider_version str
    (string)
    schedulable bool
    (boolean)
    topologies Sequence[CsiVolumeRegistrationTopology]
    (List of topologies)
    capacity Number
    capacityMaxBytes Number
    capacityMinBytes Number
    controllerRequired Boolean
    (boolean)
    controllersExpected Number
    (integer)
    controllersHealthy Number
    (integer)
    id String
    The provider-assigned unique ID for this managed resource.
    nodesExpected Number
    (integer)
    nodesHealthy Number
    (integer)
    pluginProvider String
    (string)
    pluginProviderVersion String
    (string)
    schedulable Boolean
    (boolean)
    topologies List<Property Map>
    (List of topologies)

    Look up Existing CsiVolumeRegistration Resource

    Get an existing CsiVolumeRegistration 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?: CsiVolumeRegistrationState, opts?: CustomResourceOptions): CsiVolumeRegistration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capabilities: Optional[Sequence[CsiVolumeRegistrationCapabilityArgs]] = 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,
        context: Optional[Mapping[str, str]] = None,
        controller_required: Optional[bool] = None,
        controllers_expected: Optional[int] = None,
        controllers_healthy: Optional[int] = None,
        deregister_on_destroy: Optional[bool] = None,
        external_id: Optional[str] = None,
        mount_options: Optional[CsiVolumeRegistrationMountOptionsArgs] = 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,
        topologies: Optional[Sequence[CsiVolumeRegistrationTopologyArgs]] = None,
        topology_request: Optional[CsiVolumeRegistrationTopologyRequestArgs] = None,
        volume_id: Optional[str] = None) -> CsiVolumeRegistration
    func GetCsiVolumeRegistration(ctx *Context, name string, id IDInput, state *CsiVolumeRegistrationState, opts ...ResourceOption) (*CsiVolumeRegistration, error)
    public static CsiVolumeRegistration Get(string name, Input<string> id, CsiVolumeRegistrationState? state, CustomResourceOptions? opts = null)
    public static CsiVolumeRegistration get(String name, Output<String> id, CsiVolumeRegistrationState 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.
    The following state arguments are supported:
    Capabilities List<CsiVolumeRegistrationCapability>
    (``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
    Context Dictionary<string, string>
    (map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.
    ControllerRequired bool
    (boolean)
    ControllersExpected int
    (integer)
    ControllersHealthy int
    (integer)
    DeregisterOnDestroy bool
    (boolean: true) - If true, the volume will be deregistered on destroy.
    ExternalId string
    (string: <required>) - The ID of the physical volume from the storage provider.
    MountOptions CsiVolumeRegistrationMountOptions
    (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 string
    (string: "default") - The namespace in which to register the volume.
    NodesExpected int
    (integer)
    NodesHealthy int
    (integer)
    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 string
    (string: <required>) - The ID of the Nomad plugin for registering this volume.
    PluginProvider string
    (string)
    PluginProviderVersion string
    (string)
    Schedulable bool
    (boolean)
    Secrets Dictionary<string, string>
    (map[string]string: <optional>) - An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
    Topologies List<CsiVolumeRegistrationTopology>
    (List of topologies)
    TopologyRequest CsiVolumeRegistrationTopologyRequest
    (``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
    VolumeId string
    (string: <required>) - The unique ID of the volume.
    Capabilities []CsiVolumeRegistrationCapabilityArgs
    (``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
    Context map[string]string
    (map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.
    ControllerRequired bool
    (boolean)
    ControllersExpected int
    (integer)
    ControllersHealthy int
    (integer)
    DeregisterOnDestroy bool
    (boolean: true) - If true, the volume will be deregistered on destroy.
    ExternalId string
    (string: <required>) - The ID of the physical volume from the storage provider.
    MountOptions CsiVolumeRegistrationMountOptionsArgs
    (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 string
    (string: "default") - The namespace in which to register the volume.
    NodesExpected int
    (integer)
    NodesHealthy int
    (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 string
    (string: <required>) - The ID of the Nomad plugin for registering this volume.
    PluginProvider string
    (string)
    PluginProviderVersion string
    (string)
    Schedulable bool
    (boolean)
    Secrets map[string]string
    (map[string]string: <optional>) - An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
    Topologies []CsiVolumeRegistrationTopologyArgs
    (List of topologies)
    TopologyRequest CsiVolumeRegistrationTopologyRequestArgs
    (``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
    VolumeId string
    (string: <required>) - The unique ID of the volume.
    capabilities List<CsiVolumeRegistrationCapability>
    (``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
    context Map<String,String>
    (map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.
    controllerRequired Boolean
    (boolean)
    controllersExpected Integer
    (integer)
    controllersHealthy Integer
    (integer)
    deregisterOnDestroy Boolean
    (boolean: true) - If true, the volume will be deregistered on destroy.
    externalId String
    (string: <required>) - The ID of the physical volume from the storage provider.
    mountOptions CsiVolumeRegistrationMountOptions
    (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 String
    (string: "default") - The namespace in which to register the volume.
    nodesExpected Integer
    (integer)
    nodesHealthy Integer
    (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 String
    (string: <required>) - The ID of the Nomad plugin for registering this volume.
    pluginProvider String
    (string)
    pluginProviderVersion String
    (string)
    schedulable Boolean
    (boolean)
    secrets Map<String,String>
    (map[string]string: <optional>) - An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
    topologies List<CsiVolumeRegistrationTopology>
    (List of topologies)
    topologyRequest CsiVolumeRegistrationTopologyRequest
    (``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
    volumeId String
    (string: <required>) - The unique ID of the volume.
    capabilities CsiVolumeRegistrationCapability[]
    (``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
    context {[key: string]: string}
    (map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.
    controllerRequired boolean
    (boolean)
    controllersExpected number
    (integer)
    controllersHealthy number
    (integer)
    deregisterOnDestroy boolean
    (boolean: true) - If true, the volume will be deregistered on destroy.
    externalId string
    (string: <required>) - The ID of the physical volume from the storage provider.
    mountOptions CsiVolumeRegistrationMountOptions
    (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 string
    (string: "default") - The namespace in which to register the volume.
    nodesExpected number
    (integer)
    nodesHealthy number
    (integer)
    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 string
    (string: <required>) - The ID of the Nomad plugin for registering this volume.
    pluginProvider string
    (string)
    pluginProviderVersion string
    (string)
    schedulable boolean
    (boolean)
    secrets {[key: string]: string}
    (map[string]string: <optional>) - An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
    topologies CsiVolumeRegistrationTopology[]
    (List of topologies)
    topologyRequest CsiVolumeRegistrationTopologyRequest
    (``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
    volumeId string
    (string: <required>) - The unique ID of the volume.
    capabilities Sequence[CsiVolumeRegistrationCapabilityArgs]
    (``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
    context Mapping[str, str]
    (map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.
    controller_required bool
    (boolean)
    controllers_expected int
    (integer)
    controllers_healthy int
    (integer)
    deregister_on_destroy bool
    (boolean: true) - If true, the volume will be deregistered on destroy.
    external_id str
    (string: <required>) - The ID of the physical volume from the storage provider.
    mount_options CsiVolumeRegistrationMountOptionsArgs
    (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 str
    (string: "default") - The namespace in which to register the volume.
    nodes_expected int
    (integer)
    nodes_healthy int
    (integer)
    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
    (string)
    plugin_provider_version str
    (string)
    schedulable bool
    (boolean)
    secrets Mapping[str, str]
    (map[string]string: <optional>) - An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
    topologies Sequence[CsiVolumeRegistrationTopologyArgs]
    (List of topologies)
    topology_request CsiVolumeRegistrationTopologyRequestArgs
    (``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
    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
    context Map<String>
    (map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.
    controllerRequired Boolean
    (boolean)
    controllersExpected Number
    (integer)
    controllersHealthy Number
    (integer)
    deregisterOnDestroy Boolean
    (boolean: true) - If true, the volume will be deregistered on destroy.
    externalId String
    (string: <required>) - 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 String
    (string: "default") - The namespace in which to register the volume.
    nodesExpected Number
    (integer)
    nodesHealthy Number
    (integer)
    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 String
    (string: <required>) - The ID of the Nomad plugin for registering this volume.
    pluginProvider String
    (string)
    pluginProviderVersion String
    (string)
    schedulable Boolean
    (boolean)
    secrets Map<String>
    (map[string]string: <optional>) - An optional key-value map of strings used as credentials for publishing and unpublishing volumes.
    topologies List<Property Map>
    (List of topologies)
    topologyRequest Property Map
    (``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.
    volumeId String
    (string: <required>) - The unique ID of the volume.

    Supporting Types

    CsiVolumeRegistrationCapability, CsiVolumeRegistrationCapabilityArgs

    AccessMode 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 string
    (string: <required>) - The storage API that will be used by the volume. Possible values are:

    • block-device
    • file-system
    AccessMode 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 string
    (string: <required>) - The storage API that will be used by the volume. Possible values are:

    • block-device
    • file-system
    accessMode 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 String
    (string: <required>) - The storage API that will be used by the volume. Possible values are:

    • block-device
    • file-system
    accessMode 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 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
    accessMode 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 String
    (string: <required>) - The storage API that will be used by the volume. Possible values are:

    • block-device
    • file-system

    CsiVolumeRegistrationMountOptions, CsiVolumeRegistrationMountOptionsArgs

    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.

    CsiVolumeRegistrationTopology, CsiVolumeRegistrationTopologyArgs

    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:

    CsiVolumeRegistrationTopologyRequest, CsiVolumeRegistrationTopologyRequestArgs

    Required CsiVolumeRegistrationTopologyRequestRequired
    (``Topology``: <optional>) - Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
    Required CsiVolumeRegistrationTopologyRequestRequired
    (``Topology``: <optional>) - Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
    required CsiVolumeRegistrationTopologyRequestRequired
    (``Topology``: <optional>) - Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
    required CsiVolumeRegistrationTopologyRequestRequired
    (``Topology``: <optional>) - Required topologies indicate that the volume must be created in a location accessible from all the listed topologies.
    required CsiVolumeRegistrationTopologyRequestRequired
    (``Topology``: <optional>) - Required topologies indicate that the volume must be created in a location accessible from all 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.

    CsiVolumeRegistrationTopologyRequestRequired, CsiVolumeRegistrationTopologyRequestRequiredArgs

    Topologies List<CsiVolumeRegistrationTopologyRequestRequiredTopology>
    (List of segments: <required>) - Defines the location for the volume.
    Topologies []CsiVolumeRegistrationTopologyRequestRequiredTopology
    (List of segments: <required>) - Defines the location for the volume.
    topologies List<CsiVolumeRegistrationTopologyRequestRequiredTopology>
    (List of segments: <required>) - Defines the location for the volume.
    topologies CsiVolumeRegistrationTopologyRequestRequiredTopology[]
    (List of segments: <required>) - Defines the location for the volume.
    topologies Sequence[CsiVolumeRegistrationTopologyRequestRequiredTopology]
    (List of segments: <required>) - Defines the location for the volume.
    topologies List<Property Map>
    (List of segments: <required>) - Defines the location for the volume.

    CsiVolumeRegistrationTopologyRequestRequiredTopology, CsiVolumeRegistrationTopologyRequestRequiredTopologyArgs

    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:

    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.2.0 published on Wednesday, Mar 13, 2024 by Pulumi
    pulumi/pulumi-nomad