nomad.Job
Explore with Pulumi AI
Create Job Resource
new Job(name: string, args: JobArgs, opts?: CustomResourceOptions);
@overload
def Job(resource_name: str,
opts: Optional[ResourceOptions] = None,
consul_token: Optional[str] = None,
deregister_on_destroy: Optional[bool] = None,
deregister_on_id_change: Optional[bool] = None,
detach: Optional[bool] = None,
hcl1: Optional[bool] = None,
hcl2: Optional[JobHcl2Args] = None,
jobspec: Optional[str] = None,
json: Optional[bool] = None,
policy_override: Optional[bool] = None,
purge_on_destroy: Optional[bool] = None,
read_allocation_ids: Optional[bool] = None,
vault_token: Optional[str] = None)
@overload
def Job(resource_name: str,
args: JobArgs,
opts: Optional[ResourceOptions] = None)
func NewJob(ctx *Context, name string, args JobArgs, opts ...ResourceOption) (*Job, error)
public Job(string name, JobArgs args, CustomResourceOptions? opts = null)
type: nomad:Job
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args JobArgs
- 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 JobArgs
- 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 JobArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Job 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 Job resource accepts the following input properties:
- Jobspec string
(string: <required>)
- The contents of the jobspec to register.- Consul
Token string (string: <optional>)
- Consul token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.- Deregister
On boolDestroy If true, the job will be deregistered on destroy.
- Deregister
On boolId Change (boolean: true)
- Determines if the job will be deregistered if the ID of the job in the jobspec changes.- Detach bool
(boolean: true)
- If true, the provider will return immediately after creating or updating, instead of monitoring.- Hcl1 bool
(boolean: false)
- Set this totrue
to use the previous HCL1 parser. This option is provided for backwards compatibility only and should not be used unless absolutely necessary.- Hcl2
Job
Hcl2 (block: optional)
- Options for the HCL2 jobspec parser.- Json bool
(boolean: false)
- Set this totrue
if your jobspec is structured with JSON instead of the default HCL.- Policy
Override bool (boolean: false)
- Determines if the job will override any soft-mandatory Sentinel policies and register even if they fail.- Purge
On boolDestroy (boolean: false)
- Set this to true if you want the job to be purged when the resource is destroyed.- Read
Allocation boolIds Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- Vault
Token string (string: <optional>)
- Vault token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.
- Jobspec string
(string: <required>)
- The contents of the jobspec to register.- Consul
Token string (string: <optional>)
- Consul token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.- Deregister
On boolDestroy If true, the job will be deregistered on destroy.
- Deregister
On boolId Change (boolean: true)
- Determines if the job will be deregistered if the ID of the job in the jobspec changes.- Detach bool
(boolean: true)
- If true, the provider will return immediately after creating or updating, instead of monitoring.- Hcl1 bool
(boolean: false)
- Set this totrue
to use the previous HCL1 parser. This option is provided for backwards compatibility only and should not be used unless absolutely necessary.- Hcl2
Job
Hcl2Args (block: optional)
- Options for the HCL2 jobspec parser.- Json bool
(boolean: false)
- Set this totrue
if your jobspec is structured with JSON instead of the default HCL.- Policy
Override bool (boolean: false)
- Determines if the job will override any soft-mandatory Sentinel policies and register even if they fail.- Purge
On boolDestroy (boolean: false)
- Set this to true if you want the job to be purged when the resource is destroyed.- Read
Allocation boolIds Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- Vault
Token string (string: <optional>)
- Vault token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.
- jobspec String
(string: <required>)
- The contents of the jobspec to register.- consul
Token String (string: <optional>)
- Consul token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.- deregister
On BooleanDestroy If true, the job will be deregistered on destroy.
- deregister
On BooleanId Change (boolean: true)
- Determines if the job will be deregistered if the ID of the job in the jobspec changes.- detach Boolean
(boolean: true)
- If true, the provider will return immediately after creating or updating, instead of monitoring.- hcl1 Boolean
(boolean: false)
- Set this totrue
to use the previous HCL1 parser. This option is provided for backwards compatibility only and should not be used unless absolutely necessary.- hcl2
Job
Hcl2 (block: optional)
- Options for the HCL2 jobspec parser.- json Boolean
(boolean: false)
- Set this totrue
if your jobspec is structured with JSON instead of the default HCL.- policy
Override Boolean (boolean: false)
- Determines if the job will override any soft-mandatory Sentinel policies and register even if they fail.- purge
On BooleanDestroy (boolean: false)
- Set this to true if you want the job to be purged when the resource is destroyed.- read
Allocation BooleanIds Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- vault
Token String (string: <optional>)
- Vault token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.
- jobspec string
(string: <required>)
- The contents of the jobspec to register.- consul
Token string (string: <optional>)
- Consul token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.- deregister
On booleanDestroy If true, the job will be deregistered on destroy.
- deregister
On booleanId Change (boolean: true)
- Determines if the job will be deregistered if the ID of the job in the jobspec changes.- detach boolean
(boolean: true)
- If true, the provider will return immediately after creating or updating, instead of monitoring.- hcl1 boolean
(boolean: false)
- Set this totrue
to use the previous HCL1 parser. This option is provided for backwards compatibility only and should not be used unless absolutely necessary.- hcl2
Job
Hcl2 (block: optional)
- Options for the HCL2 jobspec parser.- json boolean
(boolean: false)
- Set this totrue
if your jobspec is structured with JSON instead of the default HCL.- policy
Override boolean (boolean: false)
- Determines if the job will override any soft-mandatory Sentinel policies and register even if they fail.- purge
On booleanDestroy (boolean: false)
- Set this to true if you want the job to be purged when the resource is destroyed.- read
Allocation booleanIds Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- vault
Token string (string: <optional>)
- Vault token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.
- jobspec str
(string: <required>)
- The contents of the jobspec to register.- consul_
token str (string: <optional>)
- Consul token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.- deregister_
on_ booldestroy If true, the job will be deregistered on destroy.
- deregister_
on_ boolid_ change (boolean: true)
- Determines if the job will be deregistered if the ID of the job in the jobspec changes.- detach bool
(boolean: true)
- If true, the provider will return immediately after creating or updating, instead of monitoring.- hcl1 bool
(boolean: false)
- Set this totrue
to use the previous HCL1 parser. This option is provided for backwards compatibility only and should not be used unless absolutely necessary.- hcl2
Job
Hcl2Args (block: optional)
- Options for the HCL2 jobspec parser.- json bool
(boolean: false)
- Set this totrue
if your jobspec is structured with JSON instead of the default HCL.- policy_
override bool (boolean: false)
- Determines if the job will override any soft-mandatory Sentinel policies and register even if they fail.- purge_
on_ booldestroy (boolean: false)
- Set this to true if you want the job to be purged when the resource is destroyed.- read_
allocation_ boolids Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- vault_
token str (string: <optional>)
- Vault token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.
- jobspec String
(string: <required>)
- The contents of the jobspec to register.- consul
Token String (string: <optional>)
- Consul token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.- deregister
On BooleanDestroy If true, the job will be deregistered on destroy.
- deregister
On BooleanId Change (boolean: true)
- Determines if the job will be deregistered if the ID of the job in the jobspec changes.- detach Boolean
(boolean: true)
- If true, the provider will return immediately after creating or updating, instead of monitoring.- hcl1 Boolean
(boolean: false)
- Set this totrue
to use the previous HCL1 parser. This option is provided for backwards compatibility only and should not be used unless absolutely necessary.- hcl2 Property Map
(block: optional)
- Options for the HCL2 jobspec parser.- json Boolean
(boolean: false)
- Set this totrue
if your jobspec is structured with JSON instead of the default HCL.- policy
Override Boolean (boolean: false)
- Determines if the job will override any soft-mandatory Sentinel policies and register even if they fail.- purge
On BooleanDestroy (boolean: false)
- Set this to true if you want the job to be purged when the resource is destroyed.- read
Allocation BooleanIds Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- vault
Token String (string: <optional>)
- Vault token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.
Outputs
All input properties are implicitly available as output properties. Additionally, the Job resource produces the following output properties:
- Allocation
Ids List<string> The IDs for allocations associated with this job.
Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- Datacenters List<string>
The target datacenters for the job, as derived from the jobspec.
- Deployment
Id string If detach = false, the ID for the deployment associated with the last job create/update, if one exists.
- Deployment
Status string If detach = false, the status for the deployment associated with the last job create/update, if one exists.
- Id string
The provider-assigned unique ID for this managed resource.
- Modify
Index string Integer that increments for each change. Used to detect any changes between plan and apply.
- Name string
The name of the job, as derived from the jobspec.
- Namespace string
The namespace of the job, as derived from the jobspec.
- Region string
The target region for the job, as derived from the jobspec.
- Task
Groups List<JobTask Group> - Type string
The type of the job, as derived from the jobspec.
- Allocation
Ids []string The IDs for allocations associated with this job.
Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- Datacenters []string
The target datacenters for the job, as derived from the jobspec.
- Deployment
Id string If detach = false, the ID for the deployment associated with the last job create/update, if one exists.
- Deployment
Status string If detach = false, the status for the deployment associated with the last job create/update, if one exists.
- Id string
The provider-assigned unique ID for this managed resource.
- Modify
Index string Integer that increments for each change. Used to detect any changes between plan and apply.
- Name string
The name of the job, as derived from the jobspec.
- Namespace string
The namespace of the job, as derived from the jobspec.
- Region string
The target region for the job, as derived from the jobspec.
- Task
Groups []JobTask Group - Type string
The type of the job, as derived from the jobspec.
- allocation
Ids List<String> The IDs for allocations associated with this job.
Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- datacenters List<String>
The target datacenters for the job, as derived from the jobspec.
- deployment
Id String If detach = false, the ID for the deployment associated with the last job create/update, if one exists.
- deployment
Status String If detach = false, the status for the deployment associated with the last job create/update, if one exists.
- id String
The provider-assigned unique ID for this managed resource.
- modify
Index String Integer that increments for each change. Used to detect any changes between plan and apply.
- name String
The name of the job, as derived from the jobspec.
- namespace String
The namespace of the job, as derived from the jobspec.
- region String
The target region for the job, as derived from the jobspec.
- task
Groups List<JobTask Group> - type String
The type of the job, as derived from the jobspec.
- allocation
Ids string[] The IDs for allocations associated with this job.
Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- datacenters string[]
The target datacenters for the job, as derived from the jobspec.
- deployment
Id string If detach = false, the ID for the deployment associated with the last job create/update, if one exists.
- deployment
Status string If detach = false, the status for the deployment associated with the last job create/update, if one exists.
- id string
The provider-assigned unique ID for this managed resource.
- modify
Index string Integer that increments for each change. Used to detect any changes between plan and apply.
- name string
The name of the job, as derived from the jobspec.
- namespace string
The namespace of the job, as derived from the jobspec.
- region string
The target region for the job, as derived from the jobspec.
- task
Groups JobTask Group[] - type string
The type of the job, as derived from the jobspec.
- allocation_
ids Sequence[str] The IDs for allocations associated with this job.
Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- datacenters Sequence[str]
The target datacenters for the job, as derived from the jobspec.
- deployment_
id str If detach = false, the ID for the deployment associated with the last job create/update, if one exists.
- deployment_
status str If detach = false, the status for the deployment associated with the last job create/update, if one exists.
- id str
The provider-assigned unique ID for this managed resource.
- modify_
index str Integer that increments for each change. Used to detect any changes between plan and apply.
- name str
The name of the job, as derived from the jobspec.
- namespace str
The namespace of the job, as derived from the jobspec.
- region str
The target region for the job, as derived from the jobspec.
- task_
groups Sequence[JobTask Group] - type str
The type of the job, as derived from the jobspec.
- allocation
Ids List<String> The IDs for allocations associated with this job.
Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- datacenters List<String>
The target datacenters for the job, as derived from the jobspec.
- deployment
Id String If detach = false, the ID for the deployment associated with the last job create/update, if one exists.
- deployment
Status String If detach = false, the status for the deployment associated with the last job create/update, if one exists.
- id String
The provider-assigned unique ID for this managed resource.
- modify
Index String Integer that increments for each change. Used to detect any changes between plan and apply.
- name String
The name of the job, as derived from the jobspec.
- namespace String
The namespace of the job, as derived from the jobspec.
- region String
The target region for the job, as derived from the jobspec.
- task
Groups List<Property Map> - type String
The type of the job, as derived from the jobspec.
Look up Existing Job Resource
Get an existing Job 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?: JobState, opts?: CustomResourceOptions): Job
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
allocation_ids: Optional[Sequence[str]] = None,
consul_token: Optional[str] = None,
datacenters: Optional[Sequence[str]] = None,
deployment_id: Optional[str] = None,
deployment_status: Optional[str] = None,
deregister_on_destroy: Optional[bool] = None,
deregister_on_id_change: Optional[bool] = None,
detach: Optional[bool] = None,
hcl1: Optional[bool] = None,
hcl2: Optional[JobHcl2Args] = None,
jobspec: Optional[str] = None,
json: Optional[bool] = None,
modify_index: Optional[str] = None,
name: Optional[str] = None,
namespace: Optional[str] = None,
policy_override: Optional[bool] = None,
purge_on_destroy: Optional[bool] = None,
read_allocation_ids: Optional[bool] = None,
region: Optional[str] = None,
task_groups: Optional[Sequence[JobTaskGroupArgs]] = None,
type: Optional[str] = None,
vault_token: Optional[str] = None) -> Job
func GetJob(ctx *Context, name string, id IDInput, state *JobState, opts ...ResourceOption) (*Job, error)
public static Job Get(string name, Input<string> id, JobState? state, CustomResourceOptions? opts = null)
public static Job get(String name, Output<String> id, JobState 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.
- Allocation
Ids List<string> The IDs for allocations associated with this job.
Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- Consul
Token string (string: <optional>)
- Consul token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.- Datacenters List<string>
The target datacenters for the job, as derived from the jobspec.
- Deployment
Id string If detach = false, the ID for the deployment associated with the last job create/update, if one exists.
- Deployment
Status string If detach = false, the status for the deployment associated with the last job create/update, if one exists.
- Deregister
On boolDestroy If true, the job will be deregistered on destroy.
- Deregister
On boolId Change (boolean: true)
- Determines if the job will be deregistered if the ID of the job in the jobspec changes.- Detach bool
(boolean: true)
- If true, the provider will return immediately after creating or updating, instead of monitoring.- Hcl1 bool
(boolean: false)
- Set this totrue
to use the previous HCL1 parser. This option is provided for backwards compatibility only and should not be used unless absolutely necessary.- Hcl2
Job
Hcl2 (block: optional)
- Options for the HCL2 jobspec parser.- Jobspec string
(string: <required>)
- The contents of the jobspec to register.- Json bool
(boolean: false)
- Set this totrue
if your jobspec is structured with JSON instead of the default HCL.- Modify
Index string Integer that increments for each change. Used to detect any changes between plan and apply.
- Name string
The name of the job, as derived from the jobspec.
- Namespace string
The namespace of the job, as derived from the jobspec.
- Policy
Override bool (boolean: false)
- Determines if the job will override any soft-mandatory Sentinel policies and register even if they fail.- Purge
On boolDestroy (boolean: false)
- Set this to true if you want the job to be purged when the resource is destroyed.- Read
Allocation boolIds Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- Region string
The target region for the job, as derived from the jobspec.
- Task
Groups List<JobTask Group> - Type string
The type of the job, as derived from the jobspec.
- Vault
Token string (string: <optional>)
- Vault token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.
- Allocation
Ids []string The IDs for allocations associated with this job.
Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- Consul
Token string (string: <optional>)
- Consul token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.- Datacenters []string
The target datacenters for the job, as derived from the jobspec.
- Deployment
Id string If detach = false, the ID for the deployment associated with the last job create/update, if one exists.
- Deployment
Status string If detach = false, the status for the deployment associated with the last job create/update, if one exists.
- Deregister
On boolDestroy If true, the job will be deregistered on destroy.
- Deregister
On boolId Change (boolean: true)
- Determines if the job will be deregistered if the ID of the job in the jobspec changes.- Detach bool
(boolean: true)
- If true, the provider will return immediately after creating or updating, instead of monitoring.- Hcl1 bool
(boolean: false)
- Set this totrue
to use the previous HCL1 parser. This option is provided for backwards compatibility only and should not be used unless absolutely necessary.- Hcl2
Job
Hcl2Args (block: optional)
- Options for the HCL2 jobspec parser.- Jobspec string
(string: <required>)
- The contents of the jobspec to register.- Json bool
(boolean: false)
- Set this totrue
if your jobspec is structured with JSON instead of the default HCL.- Modify
Index string Integer that increments for each change. Used to detect any changes between plan and apply.
- Name string
The name of the job, as derived from the jobspec.
- Namespace string
The namespace of the job, as derived from the jobspec.
- Policy
Override bool (boolean: false)
- Determines if the job will override any soft-mandatory Sentinel policies and register even if they fail.- Purge
On boolDestroy (boolean: false)
- Set this to true if you want the job to be purged when the resource is destroyed.- Read
Allocation boolIds Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- Region string
The target region for the job, as derived from the jobspec.
- Task
Groups []JobTask Group Args - Type string
The type of the job, as derived from the jobspec.
- Vault
Token string (string: <optional>)
- Vault token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.
- allocation
Ids List<String> The IDs for allocations associated with this job.
Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- consul
Token String (string: <optional>)
- Consul token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.- datacenters List<String>
The target datacenters for the job, as derived from the jobspec.
- deployment
Id String If detach = false, the ID for the deployment associated with the last job create/update, if one exists.
- deployment
Status String If detach = false, the status for the deployment associated with the last job create/update, if one exists.
- deregister
On BooleanDestroy If true, the job will be deregistered on destroy.
- deregister
On BooleanId Change (boolean: true)
- Determines if the job will be deregistered if the ID of the job in the jobspec changes.- detach Boolean
(boolean: true)
- If true, the provider will return immediately after creating or updating, instead of monitoring.- hcl1 Boolean
(boolean: false)
- Set this totrue
to use the previous HCL1 parser. This option is provided for backwards compatibility only and should not be used unless absolutely necessary.- hcl2
Job
Hcl2 (block: optional)
- Options for the HCL2 jobspec parser.- jobspec String
(string: <required>)
- The contents of the jobspec to register.- json Boolean
(boolean: false)
- Set this totrue
if your jobspec is structured with JSON instead of the default HCL.- modify
Index String Integer that increments for each change. Used to detect any changes between plan and apply.
- name String
The name of the job, as derived from the jobspec.
- namespace String
The namespace of the job, as derived from the jobspec.
- policy
Override Boolean (boolean: false)
- Determines if the job will override any soft-mandatory Sentinel policies and register even if they fail.- purge
On BooleanDestroy (boolean: false)
- Set this to true if you want the job to be purged when the resource is destroyed.- read
Allocation BooleanIds Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- region String
The target region for the job, as derived from the jobspec.
- task
Groups List<JobTask Group> - type String
The type of the job, as derived from the jobspec.
- vault
Token String (string: <optional>)
- Vault token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.
- allocation
Ids string[] The IDs for allocations associated with this job.
Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- consul
Token string (string: <optional>)
- Consul token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.- datacenters string[]
The target datacenters for the job, as derived from the jobspec.
- deployment
Id string If detach = false, the ID for the deployment associated with the last job create/update, if one exists.
- deployment
Status string If detach = false, the status for the deployment associated with the last job create/update, if one exists.
- deregister
On booleanDestroy If true, the job will be deregistered on destroy.
- deregister
On booleanId Change (boolean: true)
- Determines if the job will be deregistered if the ID of the job in the jobspec changes.- detach boolean
(boolean: true)
- If true, the provider will return immediately after creating or updating, instead of monitoring.- hcl1 boolean
(boolean: false)
- Set this totrue
to use the previous HCL1 parser. This option is provided for backwards compatibility only and should not be used unless absolutely necessary.- hcl2
Job
Hcl2 (block: optional)
- Options for the HCL2 jobspec parser.- jobspec string
(string: <required>)
- The contents of the jobspec to register.- json boolean
(boolean: false)
- Set this totrue
if your jobspec is structured with JSON instead of the default HCL.- modify
Index string Integer that increments for each change. Used to detect any changes between plan and apply.
- name string
The name of the job, as derived from the jobspec.
- namespace string
The namespace of the job, as derived from the jobspec.
- policy
Override boolean (boolean: false)
- Determines if the job will override any soft-mandatory Sentinel policies and register even if they fail.- purge
On booleanDestroy (boolean: false)
- Set this to true if you want the job to be purged when the resource is destroyed.- read
Allocation booleanIds Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- region string
The target region for the job, as derived from the jobspec.
- task
Groups JobTask Group[] - type string
The type of the job, as derived from the jobspec.
- vault
Token string (string: <optional>)
- Vault token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.
- allocation_
ids Sequence[str] The IDs for allocations associated with this job.
Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- consul_
token str (string: <optional>)
- Consul token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.- datacenters Sequence[str]
The target datacenters for the job, as derived from the jobspec.
- deployment_
id str If detach = false, the ID for the deployment associated with the last job create/update, if one exists.
- deployment_
status str If detach = false, the status for the deployment associated with the last job create/update, if one exists.
- deregister_
on_ booldestroy If true, the job will be deregistered on destroy.
- deregister_
on_ boolid_ change (boolean: true)
- Determines if the job will be deregistered if the ID of the job in the jobspec changes.- detach bool
(boolean: true)
- If true, the provider will return immediately after creating or updating, instead of monitoring.- hcl1 bool
(boolean: false)
- Set this totrue
to use the previous HCL1 parser. This option is provided for backwards compatibility only and should not be used unless absolutely necessary.- hcl2
Job
Hcl2Args (block: optional)
- Options for the HCL2 jobspec parser.- jobspec str
(string: <required>)
- The contents of the jobspec to register.- json bool
(boolean: false)
- Set this totrue
if your jobspec is structured with JSON instead of the default HCL.- modify_
index str Integer that increments for each change. Used to detect any changes between plan and apply.
- name str
The name of the job, as derived from the jobspec.
- namespace str
The namespace of the job, as derived from the jobspec.
- policy_
override bool (boolean: false)
- Determines if the job will override any soft-mandatory Sentinel policies and register even if they fail.- purge_
on_ booldestroy (boolean: false)
- Set this to true if you want the job to be purged when the resource is destroyed.- read_
allocation_ boolids Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- region str
The target region for the job, as derived from the jobspec.
- task_
groups Sequence[JobTask Group Args] - type str
The type of the job, as derived from the jobspec.
- vault_
token str (string: <optional>)
- Vault token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.
- allocation
Ids List<String> The IDs for allocations associated with this job.
Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- consul
Token String (string: <optional>)
- Consul token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.- datacenters List<String>
The target datacenters for the job, as derived from the jobspec.
- deployment
Id String If detach = false, the ID for the deployment associated with the last job create/update, if one exists.
- deployment
Status String If detach = false, the status for the deployment associated with the last job create/update, if one exists.
- deregister
On BooleanDestroy If true, the job will be deregistered on destroy.
- deregister
On BooleanId Change (boolean: true)
- Determines if the job will be deregistered if the ID of the job in the jobspec changes.- detach Boolean
(boolean: true)
- If true, the provider will return immediately after creating or updating, instead of monitoring.- hcl1 Boolean
(boolean: false)
- Set this totrue
to use the previous HCL1 parser. This option is provided for backwards compatibility only and should not be used unless absolutely necessary.- hcl2 Property Map
(block: optional)
- Options for the HCL2 jobspec parser.- jobspec String
(string: <required>)
- The contents of the jobspec to register.- json Boolean
(boolean: false)
- Set this totrue
if your jobspec is structured with JSON instead of the default HCL.- modify
Index String Integer that increments for each change. Used to detect any changes between plan and apply.
- name String
The name of the job, as derived from the jobspec.
- namespace String
The namespace of the job, as derived from the jobspec.
- policy
Override Boolean (boolean: false)
- Determines if the job will override any soft-mandatory Sentinel policies and register even if they fail.- purge
On BooleanDestroy (boolean: false)
- Set this to true if you want the job to be purged when the resource is destroyed.- read
Allocation BooleanIds Retrieving allocation IDs from the job resource is deprecated and will be removed in a future release. Use the nomad_allocations data source instead.
- region String
The target region for the job, as derived from the jobspec.
- task
Groups List<Property Map> - type String
The type of the job, as derived from the jobspec.
- vault
Token String (string: <optional>)
- Vault token used when registering this job. Will fallback to the value declared in Nomad provider configuration, if any.
Supporting Types
JobHcl2, JobHcl2Args
- Allow
Fs bool (boolean: false)
- Set this totrue
to be able to use HCL2 filesystem functions- Enabled bool
(boolean: false)
- Deprecated All HCL jobs are parsed as HCL2 by default.Starting with version 2.0.0 of the Nomad provider, jobs are parsed using HCL2 by default, so this field is no longer used and may be safely removed from your configuration files. Set 'hcl1 = true' if you must use HCL1 job parsing.
- Vars Dictionary<string, object>
- Allow
Fs bool (boolean: false)
- Set this totrue
to be able to use HCL2 filesystem functions- Enabled bool
(boolean: false)
- Deprecated All HCL jobs are parsed as HCL2 by default.Starting with version 2.0.0 of the Nomad provider, jobs are parsed using HCL2 by default, so this field is no longer used and may be safely removed from your configuration files. Set 'hcl1 = true' if you must use HCL1 job parsing.
- Vars map[string]interface{}
- allow
Fs Boolean (boolean: false)
- Set this totrue
to be able to use HCL2 filesystem functions- enabled Boolean
(boolean: false)
- Deprecated All HCL jobs are parsed as HCL2 by default.Starting with version 2.0.0 of the Nomad provider, jobs are parsed using HCL2 by default, so this field is no longer used and may be safely removed from your configuration files. Set 'hcl1 = true' if you must use HCL1 job parsing.
- vars Map<String,Object>
- allow
Fs boolean (boolean: false)
- Set this totrue
to be able to use HCL2 filesystem functions- enabled boolean
(boolean: false)
- Deprecated All HCL jobs are parsed as HCL2 by default.Starting with version 2.0.0 of the Nomad provider, jobs are parsed using HCL2 by default, so this field is no longer used and may be safely removed from your configuration files. Set 'hcl1 = true' if you must use HCL1 job parsing.
- vars {[key: string]: any}
- allow_
fs bool (boolean: false)
- Set this totrue
to be able to use HCL2 filesystem functions- enabled bool
(boolean: false)
- Deprecated All HCL jobs are parsed as HCL2 by default.Starting with version 2.0.0 of the Nomad provider, jobs are parsed using HCL2 by default, so this field is no longer used and may be safely removed from your configuration files. Set 'hcl1 = true' if you must use HCL1 job parsing.
- vars Mapping[str, Any]
- allow
Fs Boolean (boolean: false)
- Set this totrue
to be able to use HCL2 filesystem functions- enabled Boolean
(boolean: false)
- Deprecated All HCL jobs are parsed as HCL2 by default.Starting with version 2.0.0 of the Nomad provider, jobs are parsed using HCL2 by default, so this field is no longer used and may be safely removed from your configuration files. Set 'hcl1 = true' if you must use HCL1 job parsing.
- vars Map<Any>
JobTaskGroup, JobTaskGroupArgs
- Count int
- Meta Dictionary<string, object>
- Name string
- Tasks
List<Job
Task Group Task> - Volumes
List<Job
Task Group Volume>
- Count int
- Meta map[string]interface{}
- Name string
- Tasks
[]Job
Task Group Task - Volumes
[]Job
Task Group Volume
- count Integer
- meta Map<String,Object>
- name String
- tasks
List<Job
Task Group Task> - volumes
List<Job
Task Group Volume>
- count number
- meta {[key: string]: any}
- name string
- tasks
Job
Task Group Task[] - volumes
Job
Task Group Volume[]
- count int
- meta Mapping[str, Any]
- name str
- tasks
Sequence[Job
Task Group Task] - volumes
Sequence[Job
Task Group Volume]
- count Number
- meta Map<Any>
- name String
- tasks List<Property Map>
- volumes List<Property Map>
JobTaskGroupTask, JobTaskGroupTaskArgs
- Driver string
- Meta Dictionary<string, object>
- Name string
- Volume
Mounts List<JobTask Group Task Volume Mount>
- Driver string
- Meta map[string]interface{}
- Name string
- Volume
Mounts []JobTask Group Task Volume Mount
- driver String
- meta Map<String,Object>
- name String
- volume
Mounts List<JobTask Group Task Volume Mount>
- driver string
- meta {[key: string]: any}
- name string
- volume
Mounts JobTask Group Task Volume Mount[]
- driver str
- meta Mapping[str, Any]
- name str
- volume_
mounts Sequence[JobTask Group Task Volume Mount]
- driver String
- meta Map<Any>
- name String
- volume
Mounts List<Property Map>
JobTaskGroupTaskVolumeMount, JobTaskGroupTaskVolumeMountArgs
- Destination string
- Read
Only bool - Volume string
- Destination string
- Read
Only bool - Volume string
- destination String
- read
Only Boolean - volume String
- destination string
- read
Only boolean - volume string
- destination str
- read_
only bool - volume str
- destination String
- read
Only Boolean - volume String
JobTaskGroupVolume, JobTaskGroupVolumeArgs
Package Details
- Repository
- HashiCorp Nomad pulumi/pulumi-nomad
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
nomad
Terraform Provider.