Package-level declarations

Types

Link copied to clipboard
class AclAuthMethod : KotlinCustomResource

Manages an ACL Auth Method in Nomad.

Link copied to clipboard
data class AclAuthMethodArgs(val config: Output<AclAuthMethodConfigArgs>? = null, val default: Output<Boolean>? = null, val maxTokenTtl: Output<String>? = null, val name: Output<String>? = null, val tokenLocality: Output<String>? = null, val tokenNameFormat: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<AclAuthMethodArgs>

Manages an ACL Auth Method in Nomad.

Link copied to clipboard
Link copied to clipboard
object AclAuthMethodMapper : ResourceMapper<AclAuthMethod>
Link copied to clipboard
Link copied to clipboard
class AclBindingRule : KotlinCustomResource
Link copied to clipboard
data class AclBindingRuleArgs(val authMethod: Output<String>? = null, val bindName: Output<String>? = null, val bindType: Output<String>? = null, val description: Output<String>? = null, val selector: Output<String>? = null) : ConvertibleToJava<AclBindingRuleArgs>
Link copied to clipboard
Link copied to clipboard
object AclBindingRuleMapper : ResourceMapper<AclBindingRule>
Link copied to clipboard
class AclPolicy : KotlinCustomResource

Manages an ACL policy registered in Nomad.

Link copied to clipboard
data class AclPolicyArgs(val description: Output<String>? = null, val jobAcl: Output<AclPolicyJobAclArgs>? = null, val name: Output<String>? = null, val rulesHcl: Output<String>? = null) : ConvertibleToJava<AclPolicyArgs>

Manages an ACL policy registered in Nomad.

Link copied to clipboard
Link copied to clipboard
object AclPolicyMapper : ResourceMapper<AclPolicy>
Link copied to clipboard
Link copied to clipboard
class AclRole : KotlinCustomResource
Link copied to clipboard
data class AclRoleArgs(val description: Output<String>? = null, val name: Output<String>? = null, val policies: Output<List<AclRolePolicyArgs>>? = null) : ConvertibleToJava<AclRoleArgs>
Link copied to clipboard
Link copied to clipboard
object AclRoleMapper : ResourceMapper<AclRole>
Link copied to clipboard
Link copied to clipboard
class AclToken : KotlinCustomResource

Creating a token with limited policies:

Link copied to clipboard
data class AclTokenArgs(val expirationTtl: Output<String>? = null, val global: Output<Boolean>? = null, val name: Output<String>? = null, val policies: Output<List<String>>? = null, val roles: Output<List<AclTokenRoleArgs>>? = null, val type: Output<String>? = null) : ConvertibleToJava<AclTokenArgs>

Creating a token with limited policies:

Link copied to clipboard
Link copied to clipboard
object AclTokenMapper : ResourceMapper<AclToken>
Link copied to clipboard
Link copied to clipboard
class CsiVolume : KotlinCustomResource
Link copied to clipboard
data class CsiVolumeArgs(val capabilities: Output<List<CsiVolumeCapabilityArgs>>? = null, val capacityMax: Output<String>? = null, val capacityMin: Output<String>? = null, val cloneId: Output<String>? = null, val mountOptions: Output<CsiVolumeMountOptionsArgs>? = 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 snapshotId: Output<String>? = null, val topologyRequest: Output<CsiVolumeTopologyRequestArgs>? = null, val volumeId: Output<String>? = null) : ConvertibleToJava<CsiVolumeArgs>
Link copied to clipboard
Link copied to clipboard
object CsiVolumeMapper : ResourceMapper<CsiVolume>
Link copied to clipboard
class CsiVolumeRegistration : KotlinCustomResource
Link copied to clipboard
data class CsiVolumeRegistrationArgs(val capabilities: Output<List<CsiVolumeRegistrationCapabilityArgs>>? = null, val capacityMax: Output<String>? = null, val capacityMin: Output<String>? = null, val context: Output<Map<String, String>>? = null, val deregisterOnDestroy: Output<Boolean>? = null, val externalId: Output<String>? = null, val mountOptions: Output<CsiVolumeRegistrationMountOptionsArgs>? = 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<CsiVolumeRegistrationTopologyRequestArgs>? = null, val volumeId: Output<String>? = null) : ConvertibleToJava<CsiVolumeRegistrationArgs>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class DynamicHostVolume : KotlinCustomResource

layout: "nomad" page_title: "Nomad: nomad.DynamicHostVolume" sidebar_current: "docs-nomad-resource-dynamic-host-volume" description: |- Manages the lifecycle of creating and deleting dynamic host volumes.

Link copied to clipboard
data class DynamicHostVolumeArgs(val capabilities: Output<List<DynamicHostVolumeCapabilityArgs>>? = null, val capacityMax: Output<String>? = null, val capacityMin: Output<String>? = null, val constraints: Output<List<DynamicHostVolumeConstraintArgs>>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val nodeId: Output<String>? = null, val nodePool: Output<String>? = null, val parameters: Output<Map<String, String>>? = null, val pluginId: Output<String>? = null) : ConvertibleToJava<DynamicHostVolumeArgs>

layout: "nomad" page_title: "Nomad: nomad.DynamicHostVolume" sidebar_current: "docs-nomad-resource-dynamic-host-volume" description: |- Manages the lifecycle of creating and deleting dynamic host volumes.

Link copied to clipboard
object DynamicHostVolumeMapper : ResourceMapper<DynamicHostVolume>
Link copied to clipboard
class DynamicHostVolumeRegistration : KotlinCustomResource

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

Link copied to clipboard
data class DynamicHostVolumeRegistrationArgs(val capabilities: Output<List<DynamicHostVolumeRegistrationCapabilityArgs>>? = null, val capacity: Output<String>? = null, val hostPath: Output<String>? = null, val name: Output<String>? = null, val namespace: Output<String>? = null, val nodeId: Output<String>? = null, val parameters: Output<Map<String, String>>? = null) : ConvertibleToJava<DynamicHostVolumeRegistrationArgs>

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

Link copied to clipboard
class ExternalVolume : KotlinCustomResource

Creating a volume:

Link copied to clipboard
data class ExternalVolumeArgs(val capabilities: Output<List<ExternalVolumeCapabilityArgs>>? = null, val capacityMax: Output<String>? = null, val capacityMin: Output<String>? = null, val cloneId: Output<String>? = null, val mountOptions: Output<ExternalVolumeMountOptionsArgs>? = 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 snapshotId: Output<String>? = null, val topologyRequest: Output<ExternalVolumeTopologyRequestArgs>? = null, val type: Output<String>? = null, val volumeId: Output<String>? = null) : ConvertibleToJava<ExternalVolumeArgs>

Creating a volume:

Link copied to clipboard
Link copied to clipboard
object ExternalVolumeMapper : ResourceMapper<ExternalVolume>
Link copied to clipboard
class Job : KotlinCustomResource
Link copied to clipboard
data class JobArgs(val deregisterOnDestroy: Output<Boolean>? = null, val deregisterOnIdChange: Output<Boolean>? = null, val detach: Output<Boolean>? = null, val hcl2: Output<JobHcl2Args>? = null, val jobspec: Output<String>? = null, val json: Output<Boolean>? = null, val policyOverride: Output<Boolean>? = null, val purgeOnDestroy: Output<Boolean>? = null, val readAllocationIds: Output<Boolean>? = null, val rerunIfDead: Output<Boolean>? = null) : ConvertibleToJava<JobArgs>
Link copied to clipboard

Builder for JobArgs.

Link copied to clipboard
object JobMapper : ResourceMapper<Job>
Link copied to clipboard

Builder for Job.

Link copied to clipboard
class Namespace : KotlinCustomResource

Provisions a namespace within a Nomad cluster. Nomad auto-generates a default namespace called default. This namespace cannot be removed, so destroying a nomad.Namespace resource where name = "default" will cause the namespace to be reset to its default configuration.

Link copied to clipboard
data class NamespaceArgs(val capabilities: Output<NamespaceCapabilitiesArgs>? = null, val description: Output<String>? = null, val meta: Output<Map<String, String>>? = null, val name: Output<String>? = null, val nodePoolConfig: Output<NamespaceNodePoolConfigArgs>? = null, val quota: Output<String>? = null) : ConvertibleToJava<NamespaceArgs>

Provisions a namespace within a Nomad cluster. Nomad auto-generates a default namespace called default. This namespace cannot be removed, so destroying a nomad.Namespace resource where name = "default" will cause the namespace to be reset to its default configuration.

Link copied to clipboard
Link copied to clipboard
object NamespaceMapper : ResourceMapper<Namespace>
Link copied to clipboard
Link copied to clipboard
class NodePool : KotlinCustomResource

Provisions a node pool within a Nomad cluster.

Link copied to clipboard
data class NodePoolArgs(val description: Output<String>? = null, val meta: Output<Map<String, String>>? = null, val name: Output<String>? = null, val schedulerConfig: Output<NodePoolSchedulerConfigArgs>? = null) : ConvertibleToJava<NodePoolArgs>

Provisions a node pool within a Nomad cluster.

Link copied to clipboard
Link copied to clipboard
object NodePoolMapper : ResourceMapper<NodePool>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class NomadProvider : KotlinProviderResource

The provider type for the nomad package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Link copied to clipboard
object NomadProviderMapper : ResourceMapper<NomadProvider>
Link copied to clipboard
Link copied to clipboard
data class ProviderArgs(val address: Output<String>? = null, val caFile: Output<String>? = null, val caPem: Output<String>? = null, val certFile: Output<String>? = null, val certPem: Output<String>? = null, val headers: Output<List<ProviderHeaderArgs>>? = null, val httpAuth: Output<String>? = null, val ignoreEnvVars: Output<Map<String, Boolean>>? = null, val keyFile: Output<String>? = null, val keyPem: Output<String>? = null, val region: Output<String>? = null, val secretId: Output<String>? = null, val skipVerify: Output<Boolean>? = null) : ConvertibleToJava<ProviderArgs>

The provider type for the nomad package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Link copied to clipboard
Link copied to clipboard
class QuoteSpecification : KotlinCustomResource

Manages a quota specification in a Nomad cluster.

Link copied to clipboard
data class QuoteSpecificationArgs(val description: Output<String>? = null, val limits: Output<List<QuoteSpecificationLimitArgs>>? = null, val name: Output<String>? = null) : ConvertibleToJava<QuoteSpecificationArgs>

Manages a quota specification in a Nomad cluster.

Link copied to clipboard
Link copied to clipboard
class SchedulerConfig : KotlinCustomResource

Manages scheduler configuration of the Nomad cluster.

Link copied to clipboard
data class SchedulerConfigArgs(val memoryOversubscriptionEnabled: Output<Boolean>? = null, val preemptionConfig: Output<Map<String, Boolean>>? = null, val schedulerAlgorithm: Output<String>? = null) : ConvertibleToJava<SchedulerConfigArgs>

Manages scheduler configuration of the Nomad cluster.

Link copied to clipboard
object SchedulerConfigMapper : ResourceMapper<SchedulerConfig>
Link copied to clipboard
class SentinelPolicy : KotlinCustomResource

Manages a Sentinel policy registered in Nomad.

Link copied to clipboard
data class SentinelPolicyArgs(val description: Output<String>? = null, val enforcementLevel: Output<String>? = null, val name: Output<String>? = null, val policy: Output<String>? = null, val scope: Output<String>? = null) : ConvertibleToJava<SentinelPolicyArgs>

Manages a Sentinel policy registered in Nomad.

Link copied to clipboard
Link copied to clipboard
object SentinelPolicyMapper : ResourceMapper<SentinelPolicy>
Link copied to clipboard
class Variable : KotlinCustomResource

Creating a variable in the default namespace:

Link copied to clipboard
data class VariableArgs(val items: Output<Map<String, String>>? = null, val namespace: Output<String>? = null, val path: Output<String>? = null) : ConvertibleToJava<VariableArgs>

Creating a variable in the default namespace:

Link copied to clipboard
Link copied to clipboard
object VariableMapper : ResourceMapper<Variable>
Link copied to clipboard
Link copied to clipboard
class Volume : KotlinCustomResource

Registering a volume:

Link copied to clipboard
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>

Registering a volume:

Link copied to clipboard

Builder for VolumeArgs.

Link copied to clipboard
object VolumeMapper : ResourceMapper<Volume>
Link copied to clipboard

Builder for Volume.

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun aclPolicy(name: String, block: suspend AclPolicyResourceBuilder.() -> Unit): AclPolicy
Link copied to clipboard
fun aclRole(name: String): AclRole
suspend fun aclRole(name: String, block: suspend AclRoleResourceBuilder.() -> Unit): AclRole
Link copied to clipboard
suspend fun aclToken(name: String, block: suspend AclTokenResourceBuilder.() -> Unit): AclToken
Link copied to clipboard
suspend fun csiVolume(name: String, block: suspend CsiVolumeResourceBuilder.() -> Unit): CsiVolume
Link copied to clipboard
Link copied to clipboard
fun job(name: String): Job
suspend fun job(name: String, block: suspend JobResourceBuilder.() -> Unit): Job
Link copied to clipboard
suspend fun namespace(name: String, block: suspend NamespaceResourceBuilder.() -> Unit): Namespace
Link copied to clipboard
suspend fun nodePool(name: String, block: suspend NodePoolResourceBuilder.() -> Unit): NodePool
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun variable(name: String, block: suspend VariableResourceBuilder.() -> Unit): Variable
Link copied to clipboard
fun volume(name: String): Volume
suspend fun volume(name: String, block: suspend VolumeResourceBuilder.() -> Unit): Volume