Show / Hide Table of Contents

Namespace Amazon.CDK.AWS.Batch

Classes

CfnComputeEnvironment

The AWS::Batch::ComputeEnvironment resource defines your AWS Batch compute environment.

CfnComputeEnvironment.ComputeResourcesProperty

Details about the compute resources managed by the compute environment.

CfnComputeEnvironment.Ec2ConfigurationObjectProperty

Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment.

CfnComputeEnvironment.EksConfigurationProperty

Configuration for the Amazon EKS cluster that supports the AWS Batch compute environment.

CfnComputeEnvironment.LaunchTemplateSpecificationOverrideProperty

An object that represents a launch template to use in place of the default launch template.

CfnComputeEnvironment.LaunchTemplateSpecificationProperty

An object that represents a launch template that's associated with a compute resource.

CfnComputeEnvironment.UpdatePolicyProperty

Specifies the infrastructure update policy for the Amazon EC2 compute environment.

CfnComputeEnvironmentProps

Properties for defining a CfnComputeEnvironment.

CfnConsumableResource

The AWS::Batch::ConsumableResource resource specifies the parameters for an AWS Batch consumable resource.

CfnConsumableResourceProps

Properties for defining a CfnConsumableResource.

CfnJobDefinition

The AWS::Batch::JobDefinition resource specifies the parameters for an AWS Batch job definition.

CfnJobDefinition.AuthorizationConfigProperty
CfnJobDefinition.ConsumableResourcePropertiesProperty

Contains a list of consumable resources required by a job.

CfnJobDefinition.ConsumableResourceRequirementProperty

Information about a consumable resource required to run a job.

CfnJobDefinition.ContainerPropertiesProperty

Container properties are used for Amazon ECS based job definitions.

CfnJobDefinition.DeviceProperty

An object that represents a container instance host device.

CfnJobDefinition.EcsPropertiesProperty

An object that contains the properties for the Amazon ECS resources of a job.

CfnJobDefinition.EcsTaskPropertiesProperty

The properties for a task definition that describes the container and volume definitions of an Amazon ECS task.

CfnJobDefinition.EfsVolumeConfigurationProperty
CfnJobDefinition.EksContainerEnvironmentVariableProperty

An environment variable.

CfnJobDefinition.EksContainerProperty

EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job.

CfnJobDefinition.EksContainerVolumeMountProperty

The volume mounts for a container for an Amazon EKS job.

CfnJobDefinition.EksPersistentVolumeClaimProperty

A persistentVolumeClaim volume is used to mount a PersistentVolume into a Pod. PersistentVolumeClaims are a way for users to "claim" durable storage without knowing the details of the particular cloud environment. See the information about PersistentVolumes in the Kubernetes documentation .

CfnJobDefinition.EksPropertiesProperty

An object that contains the properties for the Kubernetes resources of a job.

CfnJobDefinition.EksSecretProperty

Specifies the configuration of a Kubernetes secret volume.

CfnJobDefinition.EksVolumeProperty

Specifies an Amazon EKS volume for a job definition.

CfnJobDefinition.EmptyDirProperty
CfnJobDefinition.EnvironmentProperty

The Environment property type specifies environment variables to use in a job definition.

CfnJobDefinition.EphemeralStorageProperty

The amount of ephemeral storage to allocate for the task.

CfnJobDefinition.EvaluateOnExitProperty

Specifies an array of up to 5 conditions to be met, and an action to take ( RETRY or EXIT ) if all conditions are met.

CfnJobDefinition.FargatePlatformConfigurationProperty

The platform configuration for jobs that are running on Fargate resources.

CfnJobDefinition.FirelensConfigurationProperty

The FireLens configuration for the container.

CfnJobDefinition.HostPathProperty
CfnJobDefinition.ImagePullSecretProperty

References a Kubernetes secret resource.

CfnJobDefinition.JobTimeoutProperty

An object that represents a job timeout configuration.

CfnJobDefinition.LinuxParametersProperty

Linux-specific modifications that are applied to the container, such as details for device mappings.

CfnJobDefinition.LogConfigurationProperty

Log configuration options to send to a custom log driver for the container.

CfnJobDefinition.MetadataProperty
CfnJobDefinition.MountPointProperty

Details for a Docker volume mount point that's used in a job's container properties.

CfnJobDefinition.MountPointsProperty
CfnJobDefinition.MultiNodeEcsPropertiesProperty

An object that contains the properties for the Amazon ECS resources of a job.

CfnJobDefinition.MultiNodeEcsTaskPropertiesProperty

The properties for a task definition that describes the container and volume definitions of an Amazon ECS task.

CfnJobDefinition.NetworkConfigurationProperty

The network configuration for jobs that are running on Fargate resources.

CfnJobDefinition.NodePropertiesProperty

An object that represents the node properties of a multi-node parallel job.

CfnJobDefinition.NodeRangePropertyProperty

This is an object that represents the properties of the node range for a multi-node parallel job.

CfnJobDefinition.PodPropertiesProperty
CfnJobDefinition.RepositoryCredentialsProperty

The repository credentials for private registry authentication.

CfnJobDefinition.ResourceRequirementProperty

The type and amount of a resource to assign to a container.

CfnJobDefinition.ResourcesProperty
CfnJobDefinition.RetryStrategyProperty

The retry strategy that's associated with a job.

CfnJobDefinition.RuntimePlatformProperty

An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

CfnJobDefinition.SecretProperty

An object that represents the secret to expose to your container.

CfnJobDefinition.SecurityContextProperty
CfnJobDefinition.TaskContainerDependencyProperty

A list of containers that this task depends on.

CfnJobDefinition.TaskContainerPropertiesProperty

Container properties are used for Amazon ECS-based job definitions.

CfnJobDefinition.TimeoutProperty
CfnJobDefinition.TmpfsProperty

The container path, mount options, and size of the tmpfs mount.

CfnJobDefinition.UlimitProperty

The ulimit settings to pass to the container. For more information, see Ulimit .

CfnJobDefinition.VolumesHostProperty
CfnJobDefinition.VolumesProperty
CfnJobDefinitionProps

Properties for defining a CfnJobDefinition.

CfnJobQueue

The AWS::Batch::JobQueue resource specifies the parameters for an AWS Batch job queue definition.

CfnJobQueue.ComputeEnvironmentOrderProperty

The order that compute environments are tried in for job placement within a queue.

CfnJobQueue.JobStateTimeLimitActionProperty

Specifies an action that AWS Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.

CfnJobQueueProps

Properties for defining a CfnJobQueue.

CfnSchedulingPolicy

The AWS::Batch::SchedulingPolicy resource specifies the parameters for an AWS Batch scheduling policy.

CfnSchedulingPolicy.FairsharePolicyProperty

The fair-share scheduling policy details.

CfnSchedulingPolicy.ShareAttributesProperty

Specifies the weights for the share identifiers for the fair-share policy.

CfnSchedulingPolicyProps

Properties for defining a CfnSchedulingPolicy.

ComputeEnvironmentProps

Props common to all ComputeEnvironments.

CustomReason

The corresponding Action will only be taken if all of the conditions specified here are met.

Device

A container instance host device.

EcsContainerDefinitionProps

Props to configure an EcsContainerDefinition.

EcsEc2ContainerDefinition

A container orchestrated by ECS that uses EC2 resources.

EcsEc2ContainerDefinitionProps

Props to configure an EcsEc2ContainerDefinition.

EcsFargateContainerDefinition

A container orchestrated by ECS that uses Fargate resources.

EcsFargateContainerDefinitionProps

Props to configure an EcsFargateContainerDefinition.

EcsJobDefinition

A JobDefinition that uses ECS orchestration.

EcsJobDefinitionProps

Props for EcsJobDefinition.

EcsMachineImage

A Batch MachineImage that is compatible with ECS.

EcsVolume

Represents a Volume that can be mounted to a container that uses ECS.

EcsVolumeOptions

Options to configure an EcsVolume.

EfsVolume

A Volume that uses an AWS Elastic File System (EFS);

EfsVolumeOptions

Options for configuring an EfsVolume.

EksContainerDefinition

A container that can be run with EKS orchestration on EC2 resources.

EksContainerDefinitionProps

Props to configure an EksContainerDefinition.

EksJobDefinition

A JobDefinition that uses Eks orchestration.

EksJobDefinitionProps

Props for EksJobDefinition.

EksMachineImage

A Batch MachineImage that is compatible with EKS.

EksVolume

A Volume that can be mounted to a container supported by EKS.

EksVolumeOptions

Options to configure an EksVolume.

EmptyDirVolume

A Kubernetes EmptyDir volume.

EmptyDirVolumeOptions

Options for a Kubernetes EmptyDir volume.

FairshareSchedulingPolicy

Represents a Fairshare Scheduling Policy. Instructs the scheduler to allocate ComputeEnvironment vCPUs based on Job shareIdentifiers.

FairshareSchedulingPolicyProps

Fairshare SchedulingPolicy configuration.

FargateComputeEnvironment

A ManagedComputeEnvironment that uses ECS orchestration on Fargate instances.

FargateComputeEnvironmentProps

Props for a FargateComputeEnvironment.

HostPathVolume

A Kubernetes HostPath volume.

HostPathVolumeOptions

Options for a kubernetes HostPath volume.

HostVolume

Creates a Host volume.

HostVolumeOptions

Options for configuring an ECS HostVolume.

JobDefinitionProps

Props common to all JobDefinitions.

JobQueue

JobQueues can receive Jobs, which are removed from the queue when sent to the linked ComputeEnvironment(s) to be executed.

JobQueueProps

Props to configure a JobQueue.

JobStateTimeLimitAction

Specifies an action that AWS Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.

LinuxParameters

Linux-specific options that are applied to the container.

LinuxParametersProps

The properties for defining Linux-specific options that are applied to the container.

ManagedComputeEnvironmentProps

Props for a ManagedComputeEnvironment.

ManagedEc2EcsComputeEnvironment

A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.

ManagedEc2EcsComputeEnvironmentProps

Props for a ManagedEc2EcsComputeEnvironment.

ManagedEc2EksComputeEnvironment

A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.

ManagedEc2EksComputeEnvironmentProps

Props for a ManagedEc2EksComputeEnvironment.

MultiNodeContainer

Runs the container on nodes [startNode, endNode].

MultiNodeJobDefinition

A JobDefinition that uses Ecs orchestration to run multiple containers.

MultiNodeJobDefinitionProps

Props to configure a MultiNodeJobDefinition.

OptimalInstanceType

Not a real instance type!

OrderedComputeEnvironment

Assigns an order to a ComputeEnvironment.

Reason

Common job exit reasons.

RetryStrategy

Define how Jobs using this JobDefinition respond to different exit conditions.

Secret

A secret environment variable.

SecretPathVolume

Specifies the configuration of a Kubernetes secret volume.

SecretPathVolumeOptions

Options for a Kubernetes SecretPath Volume.

SecretVersionInfo

Specify the secret's version id or version stage.

Share

Represents a group of Job Definitions.

Tmpfs

The details of a tmpfs mount for a container.

Ulimit

Sets limits for a resource with ulimit on linux systems.

UnmanagedComputeEnvironment

Unmanaged ComputeEnvironments do not provision or manage EC2 instances on your behalf.

UnmanagedComputeEnvironmentProps

Represents an UnmanagedComputeEnvironment.

Interfaces

CfnComputeEnvironment.IComputeResourcesProperty

Details about the compute resources managed by the compute environment.

CfnComputeEnvironment.IEc2ConfigurationObjectProperty

Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment.

CfnComputeEnvironment.IEksConfigurationProperty

Configuration for the Amazon EKS cluster that supports the AWS Batch compute environment.

CfnComputeEnvironment.ILaunchTemplateSpecificationOverrideProperty

An object that represents a launch template to use in place of the default launch template.

CfnComputeEnvironment.ILaunchTemplateSpecificationProperty

An object that represents a launch template that's associated with a compute resource.

CfnComputeEnvironment.IUpdatePolicyProperty

Specifies the infrastructure update policy for the Amazon EC2 compute environment.

CfnJobDefinition.IAuthorizationConfigProperty
CfnJobDefinition.IConsumableResourcePropertiesProperty

Contains a list of consumable resources required by a job.

CfnJobDefinition.IConsumableResourceRequirementProperty

Information about a consumable resource required to run a job.

CfnJobDefinition.IContainerPropertiesProperty

Container properties are used for Amazon ECS based job definitions.

CfnJobDefinition.IDeviceProperty

An object that represents a container instance host device.

CfnJobDefinition.IEcsPropertiesProperty

An object that contains the properties for the Amazon ECS resources of a job.

CfnJobDefinition.IEcsTaskPropertiesProperty

The properties for a task definition that describes the container and volume definitions of an Amazon ECS task.

CfnJobDefinition.IEfsVolumeConfigurationProperty
CfnJobDefinition.IEksContainerEnvironmentVariableProperty

An environment variable.

CfnJobDefinition.IEksContainerProperty

EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job.

CfnJobDefinition.IEksContainerVolumeMountProperty

The volume mounts for a container for an Amazon EKS job.

CfnJobDefinition.IEksPersistentVolumeClaimProperty

A persistentVolumeClaim volume is used to mount a PersistentVolume into a Pod. PersistentVolumeClaims are a way for users to "claim" durable storage without knowing the details of the particular cloud environment. See the information about PersistentVolumes in the Kubernetes documentation .

CfnJobDefinition.IEksPropertiesProperty

An object that contains the properties for the Kubernetes resources of a job.

CfnJobDefinition.IEksSecretProperty

Specifies the configuration of a Kubernetes secret volume.

CfnJobDefinition.IEksVolumeProperty

Specifies an Amazon EKS volume for a job definition.

CfnJobDefinition.IEmptyDirProperty
CfnJobDefinition.IEnvironmentProperty

The Environment property type specifies environment variables to use in a job definition.

CfnJobDefinition.IEphemeralStorageProperty

The amount of ephemeral storage to allocate for the task.

CfnJobDefinition.IEvaluateOnExitProperty

Specifies an array of up to 5 conditions to be met, and an action to take ( RETRY or EXIT ) if all conditions are met.

CfnJobDefinition.IFargatePlatformConfigurationProperty

The platform configuration for jobs that are running on Fargate resources.

CfnJobDefinition.IFirelensConfigurationProperty

The FireLens configuration for the container.

CfnJobDefinition.IHostPathProperty
CfnJobDefinition.IImagePullSecretProperty

References a Kubernetes secret resource.

CfnJobDefinition.IJobTimeoutProperty

An object that represents a job timeout configuration.

CfnJobDefinition.ILinuxParametersProperty

Linux-specific modifications that are applied to the container, such as details for device mappings.

CfnJobDefinition.ILogConfigurationProperty

Log configuration options to send to a custom log driver for the container.

CfnJobDefinition.IMetadataProperty
CfnJobDefinition.IMountPointProperty

Details for a Docker volume mount point that's used in a job's container properties.

CfnJobDefinition.IMountPointsProperty
CfnJobDefinition.IMultiNodeEcsPropertiesProperty

An object that contains the properties for the Amazon ECS resources of a job.

CfnJobDefinition.IMultiNodeEcsTaskPropertiesProperty

The properties for a task definition that describes the container and volume definitions of an Amazon ECS task.

CfnJobDefinition.INetworkConfigurationProperty

The network configuration for jobs that are running on Fargate resources.

CfnJobDefinition.INodePropertiesProperty

An object that represents the node properties of a multi-node parallel job.

CfnJobDefinition.INodeRangePropertyProperty

This is an object that represents the properties of the node range for a multi-node parallel job.

CfnJobDefinition.IPodPropertiesProperty
CfnJobDefinition.IRepositoryCredentialsProperty

The repository credentials for private registry authentication.

CfnJobDefinition.IResourceRequirementProperty

The type and amount of a resource to assign to a container.

CfnJobDefinition.IResourcesProperty
CfnJobDefinition.IRetryStrategyProperty

The retry strategy that's associated with a job.

CfnJobDefinition.IRuntimePlatformProperty

An object that represents the compute environment architecture for AWS Batch jobs on Fargate.

CfnJobDefinition.ISecretProperty

An object that represents the secret to expose to your container.

CfnJobDefinition.ISecurityContextProperty
CfnJobDefinition.ITaskContainerDependencyProperty

A list of containers that this task depends on.

CfnJobDefinition.ITaskContainerPropertiesProperty

Container properties are used for Amazon ECS-based job definitions.

CfnJobDefinition.ITimeoutProperty
CfnJobDefinition.ITmpfsProperty

The container path, mount options, and size of the tmpfs mount.

CfnJobDefinition.IUlimitProperty

The ulimit settings to pass to the container. For more information, see Ulimit .

CfnJobDefinition.IVolumesHostProperty
CfnJobDefinition.IVolumesProperty
CfnJobQueue.IComputeEnvironmentOrderProperty

The order that compute environments are tried in for job placement within a queue.

CfnJobQueue.IJobStateTimeLimitActionProperty

Specifies an action that AWS Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.

CfnSchedulingPolicy.IFairsharePolicyProperty

The fair-share scheduling policy details.

CfnSchedulingPolicy.IShareAttributesProperty

Specifies the weights for the share identifiers for the fair-share policy.

ICfnComputeEnvironmentProps

Properties for defining a CfnComputeEnvironment.

ICfnConsumableResourceProps

Properties for defining a CfnConsumableResource.

ICfnJobDefinitionProps

Properties for defining a CfnJobDefinition.

ICfnJobQueueProps

Properties for defining a CfnJobQueue.

ICfnSchedulingPolicyProps

Properties for defining a CfnSchedulingPolicy.

IComputeEnvironment

Represents a ComputeEnvironment.

IComputeEnvironmentProps

Props common to all ComputeEnvironments.

ICustomReason

The corresponding Action will only be taken if all of the conditions specified here are met.

IDevice

A container instance host device.

IEcsContainerDefinition

A container that can be run with ECS orchestration.

IEcsContainerDefinitionProps

Props to configure an EcsContainerDefinition.

IEcsEc2ContainerDefinition

A container orchestrated by ECS that uses EC2 resources.

IEcsEc2ContainerDefinitionProps

Props to configure an EcsEc2ContainerDefinition.

IEcsFargateContainerDefinition

A container orchestrated by ECS that uses Fargate resources and is orchestrated by ECS.

IEcsFargateContainerDefinitionProps

Props to configure an EcsFargateContainerDefinition.

IEcsJobDefinitionProps

Props for EcsJobDefinition.

IEcsMachineImage

A Batch MachineImage that is compatible with ECS.

IEcsVolumeOptions

Options to configure an EcsVolume.

IEfsVolumeOptions

Options for configuring an EfsVolume.

IEksContainerDefinition

A container that can be run with EKS orchestration on EC2 resources.

IEksContainerDefinitionProps

Props to configure an EksContainerDefinition.

IEksJobDefinition

A JobDefinition that uses Eks orchestration.

IEksJobDefinitionProps

Props for EksJobDefinition.

IEksMachineImage

A Batch MachineImage that is compatible with EKS.

IEksVolumeOptions

Options to configure an EksVolume.

IEmptyDirVolumeOptions

Options for a Kubernetes EmptyDir volume.

IFairshareSchedulingPolicy

Represents a Fairshare Scheduling Policy. Instructs the scheduler to allocate ComputeEnvironment vCPUs based on Job shareIdentifiers.

IFairshareSchedulingPolicyProps

Fairshare SchedulingPolicy configuration.

IFargateComputeEnvironment

A ManagedComputeEnvironment that uses ECS orchestration on Fargate instances.

IFargateComputeEnvironmentProps

Props for a FargateComputeEnvironment.

IHostPathVolumeOptions

Options for a kubernetes HostPath volume.

IHostVolumeOptions

Options for configuring an ECS HostVolume.

IJobDefinition

Represents a JobDefinition.

IJobDefinitionProps

Props common to all JobDefinitions.

IJobQueue

Represents a JobQueue.

IJobQueueProps

Props to configure a JobQueue.

IJobStateTimeLimitAction

Specifies an action that AWS Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.

ILinuxParametersProps

The properties for defining Linux-specific options that are applied to the container.

IManagedComputeEnvironment

Represents a Managed ComputeEnvironment.

IManagedComputeEnvironmentProps

Props for a ManagedComputeEnvironment.

IManagedEc2EcsComputeEnvironment

A ManagedComputeEnvironment that uses ECS orchestration on EC2 instances.

IManagedEc2EcsComputeEnvironmentProps

Props for a ManagedEc2EcsComputeEnvironment.

IManagedEc2EksComputeEnvironmentProps

Props for a ManagedEc2EksComputeEnvironment.

IMultiNodeContainer

Runs the container on nodes [startNode, endNode].

IMultiNodeJobDefinitionProps

Props to configure a MultiNodeJobDefinition.

IOrderedComputeEnvironment

Assigns an order to a ComputeEnvironment.

ISchedulingPolicy

Represents a Scheduling Policy.

ISecretPathVolumeOptions

Options for a Kubernetes SecretPath Volume.

ISecretVersionInfo

Specify the secret's version id or version stage.

IShare

Represents a group of Job Definitions.

ITmpfs

The details of a tmpfs mount for a container.

IUlimit

Sets limits for a resource with ulimit on linux systems.

IUnmanagedComputeEnvironment

Represents an UnmanagedComputeEnvironment.

IUnmanagedComputeEnvironmentProps

Represents an UnmanagedComputeEnvironment.

Enums

Action

The Action to take when all specified conditions in a RetryStrategy are met.

AllocationStrategy

Determines how this compute environment chooses instances to spawn.

DevicePermission

Permissions for device access.

DnsPolicy

The DNS Policy for the pod used by the Job Definition.

EcsMachineImageType

Maps the image to instance types.

EksMachineImageType

Maps the image to instance types.

EmptyDirMediumType

What medium the volume will live in.

ImagePullPolicy

Determines when the image is pulled from the registry to launch a container.

JobStateTimeLimitActionsAction

The action to take when a job is at the head of the job queue in the specified state for the specified period of time.

JobStateTimeLimitActionsReason

The reason to log for the action being taken.

JobStateTimeLimitActionsState

The state of the job needed to trigger the action.

TmpfsMountOption

The supported options for a tmpfs mount for a container.

UlimitName

The resources to be limited.

Back to top Generated by DocFX