You are viewing an outdated version of provider-aws-batch.Go to Latest
upbound/provider-aws-batch@v1.14.0
JobDefinition
batch.aws.upbound.io
JobDefinition
upbound/provider-aws-batch@v1.14.0batch.aws.upbound.io

JobDefinition is the Schema for the JobDefinitions API. Provides a Batch Job Definition resource.

Type

CRD

Group

batch.aws.upbound.io

Version

apiVersion: batch.aws.upbound.io/v1beta1

kind: JobDefinition

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

JobDefinitionSpec defines the desired state of JobDefinition

forProvider
requiredobject
requiredobject

No description provided.

array

A valid eks properties. This parameter is only valid if the type parameter is container.

array

The properties for the Kubernetes pod resources of a job. See pod_properties below.

array

The properties of the container that's used on the Amazon EKS pod. See containers below.

args
array
array

An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

command
array
array

The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT of the container image is used. Environment variable references are expanded using the container's environment.

env
array
array

The environment variables to pass to a container. See EKS Environment below.

name
string
value
string
image
string
name
string
array

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu.

limits
object
requests
object
array

The security context for a job.

array

The volume mounts for the container.

mountPath
string
name
string
readOnly
boolean
dnsPolicy
string
array

Metadata about the Kubernetes pod.

labels
object
volumes
array
array

Specifies the volumes for a job definition that uses Amazon EKS resources. AWS Batch supports emptyDir, hostPath, and secret volume types.

array

No description provided.

medium
string
sizeLimit
string
array

The path of the file or directory on the host to mount into containers on the pod.

path
string
name
string
secret
array
array

No description provided.

optional
boolean
name
string
array

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

region
requiredstring
array

Specifies the retry strategy to use for failed jobs that are submitted with this job definition. Maximum number of retry_strategy is 1. Defined below.

attempts
number
array

The evaluate on exit conditions under which the job should be retried or failed. If this parameter is specified, then the attempts parameter must also be specified. You may specify up to 5 configuration blocks.

tags
object
timeout
array
array

Specifies the timeout for jobs so that if a job runs longer, AWS Batch terminates the job. Maximum number of timeout is 1. Defined below.

type
string
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

array

A valid eks properties. This parameter is only valid if the type parameter is container.

array

The properties for the Kubernetes pod resources of a job. See pod_properties below.

array

The properties of the container that's used on the Amazon EKS pod. See containers below.

args
array
array

An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

command
array
array

The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT of the container image is used. Environment variable references are expanded using the container's environment.

env
array
array

The environment variables to pass to a container. See EKS Environment below.

name
string
value
string
image
string
name
string
array

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu.

limits
object
requests
object
array

The security context for a job.

array

The volume mounts for the container.

mountPath
string
name
string
readOnly
boolean
dnsPolicy
string
array

Metadata about the Kubernetes pod.

labels
object
volumes
array
array

Specifies the volumes for a job definition that uses Amazon EKS resources. AWS Batch supports emptyDir, hostPath, and secret volume types.

array

No description provided.

medium
string
sizeLimit
string
array

The path of the file or directory on the host to mount into containers on the pod.

path
string
name
string
secret
array
array

No description provided.

optional
boolean
name
string
array

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

array

Specifies the retry strategy to use for failed jobs that are submitted with this job definition. Maximum number of retry_strategy is 1. Defined below.

attempts
number
array

The evaluate on exit conditions under which the job should be retried or failed. If this parameter is specified, then the attempts parameter must also be specified. You may specify up to 5 configuration blocks.

tags
object
timeout
array
array

Specifies the timeout for jobs so that if a job runs longer, AWS Batch terminates the job. Maximum number of timeout is 1. Defined below.

type
string
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

JobDefinitionStatus defines the observed state of JobDefinition.

object

No description provided.

arn
string
arnPrefix
string
array

A valid eks properties. This parameter is only valid if the type parameter is container.

array

The properties for the Kubernetes pod resources of a job. See pod_properties below.

array

The properties of the container that's used on the Amazon EKS pod. See containers below.

args
array
array

An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

command
array
array

The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT of the container image is used. Environment variable references are expanded using the container's environment.

env
array
array

The environment variables to pass to a container. See EKS Environment below.

name
string
value
string
image
string
name
string
array

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu.

limits
object
requests
object
array

The security context for a job.

array

The volume mounts for the container.

mountPath
string
name
string
readOnly
boolean
dnsPolicy
string
array

Metadata about the Kubernetes pod.

labels
object
volumes
array
array

Specifies the volumes for a job definition that uses Amazon EKS resources. AWS Batch supports emptyDir, hostPath, and secret volume types.

array

No description provided.

medium
string
sizeLimit
string
array

The path of the file or directory on the host to mount into containers on the pod.

path
string
name
string
secret
array
array

No description provided.

optional
boolean
id
string
name
string
array

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

array

Specifies the retry strategy to use for failed jobs that are submitted with this job definition. Maximum number of retry_strategy is 1. Defined below.

attempts
number
array

The evaluate on exit conditions under which the job should be retried or failed. If this parameter is specified, then the attempts parameter must also be specified. You may specify up to 5 configuration blocks.

revision
number
tags
object
tagsAll
object
timeout
array
array

Specifies the timeout for jobs so that if a job runs longer, AWS Batch terminates the job. Maximum number of timeout is 1. Defined below.

type
string
array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Discover the building blocks for your internal cloud platform.
© 2024 Upbound, Inc.
Solutions