pulumi-nomad-kotlin/com.pulumi.nomad.kotlin/VolumeArgs

VolumeArgs

data class VolumeArgs(val accessMode: Output<String>? = null, val attachmentMode: Output<String>? = null, val capabilities: Output<List<VolumeCapabilityArgs>>? = null, val context: Output<Map<String, String>>? = null, val deregisterOnDestroy: Output<Boolean>? = null, val externalId: Output<String>? = null, val mountOptions: Output<VolumeMountOptionsArgs>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val parameters: Output<Map<String, String>>? = null, val pluginId: Output<String>? = null, val secrets: Output<Map<String, String>>? = null, val topologyRequest: Output<VolumeTopologyRequestArgs>? = null, val type: Output<String>? = null, val volumeId: Output<String>? = null) : ConvertibleToJava<VolumeArgs>

Example Usage

Registering a volume:

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nomad.NomadFunctions;
import com.pulumi.nomad.inputs.GetPluginArgs;
import com.pulumi.nomad.Volume;
import com.pulumi.nomad.VolumeArgs;
import com.pulumi.nomad.inputs.VolumeCapabilityArgs;
import com.pulumi.nomad.inputs.VolumeMountOptionsArgs;
import com.pulumi.nomad.inputs.VolumeTopologyRequestArgs;
import com.pulumi.nomad.inputs.VolumeTopologyRequestRequiredArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var ebs = NomadFunctions.getPlugin(GetPluginArgs.builder()
            .pluginId("aws-ebs0")
            .waitForHealthy(true)
            .build());
        var mysqlVolume = new Volume("mysqlVolume", VolumeArgs.builder()
            .type("csi")
            .pluginId("aws-ebs0")
            .volumeId("mysql_volume")
            .externalId(module.hashistack().ebs_test_volume_id())
            .capabilities(VolumeCapabilityArgs.builder()
                .accessMode("single-node-writer")
                .attachmentMode("file-system")
                .build())
            .mountOptions(VolumeMountOptionsArgs.builder()
                .fsType("ext4")
                .build())
            .topologyRequest(VolumeTopologyRequestArgs.builder()
                .required(VolumeTopologyRequestRequiredArgs.builder()
                    .topologies(
                        VolumeTopologyRequestRequiredTopologyArgs.builder()
                            .segments(Map.ofEntries(
                                Map.entry("rack", "R1"),
                                Map.entry("zone", "us-east-1a")
                            ))
                            .build(),
                        VolumeTopologyRequestRequiredTopologyArgs.builder()
                            .segments(Map.of("rack", "R2"))
                            .build())
                    .build())
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(ebs.applyValue(getPluginResult -> getPluginResult))
                .build());
    }
}

Constructors

VolumeArgs

fun VolumeArgs(accessMode: Output<String>? = null, attachmentMode: Output<String>? = null, capabilities: Output<List<VolumeCapabilityArgs>>? = null, context: Output<Map<String, String>>? = null, deregisterOnDestroy: Output<Boolean>? = null, externalId: Output<String>? = null, mountOptions: Output<VolumeMountOptionsArgs>? = null, name: Output<String>? = null, namespace: Output<String>? = null, parameters: Output<Map<String, String>>? = null, pluginId: Output<String>? = null, secrets: Output<Map<String, String>>? = null, topologyRequest: Output<VolumeTopologyRequestArgs>? = null, type: Output<String>? = null, volumeId: Output<String>? = null)

Functions

toJava

open override fun toJava(): VolumeArgs

Properties

accessMode

val ~~accessMode~~: Output<String>? = null

(string: <optional>) - Deprecated. Use capability block instead. Defines whether a volume should be available concurrently. Possible values are:

attachmentMode

val ~~attachmentMode~~: Output<String>? = null

(string: <otional>) - Deprecated. Use capability block instead. The storage API that will be used by the volume.

capabilities

val capabilities: Output<List<VolumeCapabilityArgs>>? = null

(``Capability``: <required>) - Options for validating the capability of a volume.

context

val context: Output<Map<String, String>>? = null

(map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to validate the volume.

deregisterOnDestroy

val deregisterOnDestroy: Output<Boolean>? = null

(boolean: false) - If true, the volume will be deregistered on destroy.

externalId

val externalId: Output<String>? = null

(string: <required>) - The ID of the physical volume from the storage provider.

mountOptions

val mountOptions: Output<VolumeMountOptionsArgs>? = null

(block: <optional>) Options for mounting block-device volumes without a pre-formatted file system.

name

val name: Output<String>? = null

(string: <required>) - The display name for the volume.

namespace

val namespace: Output<String>? = null

(string: "default") - The namespace in which to register the volume.

parameters

val parameters: Output<Map<String, String>>? = null

(map[string]string: <optional>) - An optional key-value map of strings passed directly to the CSI plugin to configure the volume.

pluginId

val pluginId: Output<String>? = null

(string: <required>) - The ID of the Nomad plugin for registering this volume.

secrets

val secrets: Output<Map<String, String>>? = null

(map[string]string: <optional>) - An optional key-value map of strings used as credentials for publishing and unpublishing volumes.

topologyRequest

val topologyRequest: Output<VolumeTopologyRequestArgs>? = null

(``TopologyRequest``: <optional>) - Specify locations (region, zone, rack, etc.) where the provisioned volume is accessible from.

type

val type: Output<String>? = null

(string: <required>) - The type of the volume. Currently, only csi is supported.

volumeId

val volumeId: Output<String>? = null

(string: <required>) - The unique ID of the volume.