This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-batch

The CDK Construct Library for AWS Batch

This module is part of the AWS Cloud Development Kit project.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.Batch" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.Batch --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.Batch" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:batch:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="batch" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>batch</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:batch:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='batch', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-batch@0.25.3

package.json:

{
  "@aws-cdk/aws-batch": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-batch@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-batch@0.25.3

package.json:

{
  "@aws-cdk/aws-batch": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-batch@0.25.3

CfnComputeEnvironment

class @aws-cdk/aws-batch.CfnComputeEnvironment(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnComputeEnvironment;
const { CfnComputeEnvironment } = require('@aws-cdk/aws-batch');
import { CfnComputeEnvironment } from '@aws-cdk/aws-batch';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
computeEnvironmentArn
Type:string (readonly)
propertyOverrides
Type:CfnComputeEnvironmentProps (readonly)
class ComputeResourcesProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnComputeEnvironment.ComputeResourcesProperty;
// CfnComputeEnvironment.ComputeResourcesProperty is an interface
import { CfnComputeEnvironment.ComputeResourcesProperty } from '@aws-cdk/aws-batch';
instanceRole

CfnComputeEnvironment.ComputeResourcesProperty.InstanceRole

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancerole

Type:string
instanceTypes

CfnComputeEnvironment.ComputeResourcesProperty.InstanceTypes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-instancetypes

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[]
maxvCpus

CfnComputeEnvironment.ComputeResourcesProperty.MaxvCpus

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-maxvcpus

Type:number or @aws-cdk/cdk.Token
minvCpus

CfnComputeEnvironment.ComputeResourcesProperty.MinvCpus

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-minvcpus

Type:number or @aws-cdk/cdk.Token
securityGroupIds

CfnComputeEnvironment.ComputeResourcesProperty.SecurityGroupIds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-securitygroupids

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[]
subnets

CfnComputeEnvironment.ComputeResourcesProperty.Subnets

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-subnets

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[]
type

CfnComputeEnvironment.ComputeResourcesProperty.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-type

Type:string
bidPercentage

CfnComputeEnvironment.ComputeResourcesProperty.BidPercentage

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-bidpercentage

Type:number or @aws-cdk/cdk.Token (optional)
desiredvCpus

CfnComputeEnvironment.ComputeResourcesProperty.DesiredvCpus

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-desiredvcpus

Type:number or @aws-cdk/cdk.Token (optional)
ec2KeyPair

CfnComputeEnvironment.ComputeResourcesProperty.Ec2KeyPair

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-ec2keypair

Type:string (optional)
imageId

CfnComputeEnvironment.ComputeResourcesProperty.ImageId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-imageid

Type:string (optional)
launchTemplate

CfnComputeEnvironment.ComputeResourcesProperty.LaunchTemplate

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-launchtemplate

Type:@aws-cdk/cdk.Token or LaunchTemplateSpecificationProperty (optional)
placementGroup

CfnComputeEnvironment.ComputeResourcesProperty.PlacementGroup

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-placementgroup

Type:string (optional)
spotIamFleetRole

CfnComputeEnvironment.ComputeResourcesProperty.SpotIamFleetRole

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-spotiamfleetrole

Type:string (optional)
tags

CfnComputeEnvironment.ComputeResourcesProperty.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-computeresources.html#cfn-batch-computeenvironment-computeresources-tags

Type:json or @aws-cdk/cdk.Token (optional)
class LaunchTemplateSpecificationProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnComputeEnvironment.LaunchTemplateSpecificationProperty;
// CfnComputeEnvironment.LaunchTemplateSpecificationProperty is an interface
import { CfnComputeEnvironment.LaunchTemplateSpecificationProperty } from '@aws-cdk/aws-batch';
launchTemplateId

CfnComputeEnvironment.LaunchTemplateSpecificationProperty.LaunchTemplateId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-launchtemplateid

Type:string (optional)
launchTemplateName

CfnComputeEnvironment.LaunchTemplateSpecificationProperty.LaunchTemplateName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-launchtemplatename

Type:string (optional)
version

CfnComputeEnvironment.LaunchTemplateSpecificationProperty.Version

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-computeenvironment-launchtemplatespecification.html#cfn-batch-computeenvironment-launchtemplatespecification-version

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnComputeEnvironmentProps (interface)

class @aws-cdk/aws-batch.CfnComputeEnvironmentProps

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnComputeEnvironmentProps;
// CfnComputeEnvironmentProps is an interface
import { CfnComputeEnvironmentProps } from '@aws-cdk/aws-batch';
serviceRole

AWS::Batch::ComputeEnvironment.ServiceRole

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-servicerole

Type:string
type

AWS::Batch::ComputeEnvironment.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-type

Type:string
computeEnvironmentName

AWS::Batch::ComputeEnvironment.ComputeEnvironmentName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-computeenvironmentname

Type:string (optional)
computeResources

AWS::Batch::ComputeEnvironment.ComputeResources

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-computeresources

Type:ComputeResourcesProperty or @aws-cdk/cdk.Token (optional)
state

AWS::Batch::ComputeEnvironment.State

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-computeenvironment.html#cfn-batch-computeenvironment-state

Type:string (optional)

CfnJobDefinition

class @aws-cdk/aws-batch.CfnJobDefinition(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobDefinition;
const { CfnJobDefinition } = require('@aws-cdk/aws-batch');
import { CfnJobDefinition } from '@aws-cdk/aws-batch';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
jobDefinitionArn
Type:string (readonly)
propertyOverrides
Type:CfnJobDefinitionProps (readonly)
class ContainerPropertiesProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobDefinition.ContainerPropertiesProperty;
// CfnJobDefinition.ContainerPropertiesProperty is an interface
import { CfnJobDefinition.ContainerPropertiesProperty } from '@aws-cdk/aws-batch';
image

CfnJobDefinition.ContainerPropertiesProperty.Image

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-image

Type:string
memory

CfnJobDefinition.ContainerPropertiesProperty.Memory

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-memory

Type:number or @aws-cdk/cdk.Token
vcpus

CfnJobDefinition.ContainerPropertiesProperty.Vcpus

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-vcpus

Type:number or @aws-cdk/cdk.Token
command

CfnJobDefinition.ContainerPropertiesProperty.Command

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-command

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
environment

CfnJobDefinition.ContainerPropertiesProperty.Environment

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-environment

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or EnvironmentProperty)[] (optional)
instanceType

CfnJobDefinition.ContainerPropertiesProperty.InstanceType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-instancetype

Type:string (optional)
jobRoleArn

CfnJobDefinition.ContainerPropertiesProperty.JobRoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-jobrolearn

Type:string (optional)
mountPoints

CfnJobDefinition.ContainerPropertiesProperty.MountPoints

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-mountpoints

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or MountPointsProperty)[] (optional)
privileged

CfnJobDefinition.ContainerPropertiesProperty.Privileged

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-privileged

Type:boolean or @aws-cdk/cdk.Token (optional)
readonlyRootFilesystem

CfnJobDefinition.ContainerPropertiesProperty.ReadonlyRootFilesystem

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-readonlyrootfilesystem

Type:boolean or @aws-cdk/cdk.Token (optional)
ulimits

CfnJobDefinition.ContainerPropertiesProperty.Ulimits

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-ulimits

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or UlimitProperty)[] (optional)
user

CfnJobDefinition.ContainerPropertiesProperty.User

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-user

Type:string (optional)
volumes

CfnJobDefinition.ContainerPropertiesProperty.Volumes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-containerproperties.html#cfn-batch-jobdefinition-containerproperties-volumes

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or VolumesProperty)[] (optional)
class EnvironmentProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobDefinition.EnvironmentProperty;
// CfnJobDefinition.EnvironmentProperty is an interface
import { CfnJobDefinition.EnvironmentProperty } from '@aws-cdk/aws-batch';
name

CfnJobDefinition.EnvironmentProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html#cfn-batch-jobdefinition-environment-name

Type:string (optional)
value

CfnJobDefinition.EnvironmentProperty.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-environment.html#cfn-batch-jobdefinition-environment-value

Type:string (optional)
class MountPointsProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobDefinition.MountPointsProperty;
// CfnJobDefinition.MountPointsProperty is an interface
import { CfnJobDefinition.MountPointsProperty } from '@aws-cdk/aws-batch';
containerPath

CfnJobDefinition.MountPointsProperty.ContainerPath

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-containerpath

Type:string (optional)
readOnly

CfnJobDefinition.MountPointsProperty.ReadOnly

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-readonly

Type:boolean or @aws-cdk/cdk.Token (optional)
sourceVolume

CfnJobDefinition.MountPointsProperty.SourceVolume

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-mountpoints.html#cfn-batch-jobdefinition-mountpoints-sourcevolume

Type:string (optional)
class NodePropertiesProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobDefinition.NodePropertiesProperty;
// CfnJobDefinition.NodePropertiesProperty is an interface
import { CfnJobDefinition.NodePropertiesProperty } from '@aws-cdk/aws-batch';
mainNode

CfnJobDefinition.NodePropertiesProperty.MainNode

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-mainnode

Type:number or @aws-cdk/cdk.Token
nodeRangeProperties

CfnJobDefinition.NodePropertiesProperty.NodeRangeProperties

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-noderangeproperties

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or NodeRangePropertyProperty)[]
numNodes

CfnJobDefinition.NodePropertiesProperty.NumNodes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-nodeproperties.html#cfn-batch-jobdefinition-nodeproperties-numnodes

Type:number or @aws-cdk/cdk.Token
class NodeRangePropertyProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobDefinition.NodeRangePropertyProperty;
// CfnJobDefinition.NodeRangePropertyProperty is an interface
import { CfnJobDefinition.NodeRangePropertyProperty } from '@aws-cdk/aws-batch';
targetNodes

CfnJobDefinition.NodeRangePropertyProperty.TargetNodes

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-targetnodes

Type:string
container

CfnJobDefinition.NodeRangePropertyProperty.Container

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-noderangeproperty.html#cfn-batch-jobdefinition-noderangeproperty-container

Type:@aws-cdk/cdk.Token or ContainerPropertiesProperty (optional)
class RetryStrategyProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobDefinition.RetryStrategyProperty;
// CfnJobDefinition.RetryStrategyProperty is an interface
import { CfnJobDefinition.RetryStrategyProperty } from '@aws-cdk/aws-batch';
attempts

CfnJobDefinition.RetryStrategyProperty.Attempts

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-retrystrategy.html#cfn-batch-jobdefinition-retrystrategy-attempts

Type:number or @aws-cdk/cdk.Token (optional)
class TimeoutProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobDefinition.TimeoutProperty;
// CfnJobDefinition.TimeoutProperty is an interface
import { CfnJobDefinition.TimeoutProperty } from '@aws-cdk/aws-batch';
attemptDurationSeconds

CfnJobDefinition.TimeoutProperty.AttemptDurationSeconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-timeout.html#cfn-batch-jobdefinition-timeout-attemptdurationseconds

Type:number or @aws-cdk/cdk.Token (optional)
class UlimitProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobDefinition.UlimitProperty;
// CfnJobDefinition.UlimitProperty is an interface
import { CfnJobDefinition.UlimitProperty } from '@aws-cdk/aws-batch';
hardLimit

CfnJobDefinition.UlimitProperty.HardLimit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-hardlimit

Type:number or @aws-cdk/cdk.Token
name

CfnJobDefinition.UlimitProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-name

Type:string
softLimit

CfnJobDefinition.UlimitProperty.SoftLimit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-ulimit.html#cfn-batch-jobdefinition-ulimit-softlimit

Type:number or @aws-cdk/cdk.Token
class VolumesHostProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobDefinition.VolumesHostProperty;
// CfnJobDefinition.VolumesHostProperty is an interface
import { CfnJobDefinition.VolumesHostProperty } from '@aws-cdk/aws-batch';
sourcePath

CfnJobDefinition.VolumesHostProperty.SourcePath

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumeshost.html#cfn-batch-jobdefinition-volumeshost-sourcepath

Type:string (optional)
class VolumesProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobDefinition.VolumesProperty;
// CfnJobDefinition.VolumesProperty is an interface
import { CfnJobDefinition.VolumesProperty } from '@aws-cdk/aws-batch';
host

CfnJobDefinition.VolumesProperty.Host

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumes.html#cfn-batch-jobdefinition-volumes-host

Type:@aws-cdk/cdk.Token or VolumesHostProperty (optional)
name

CfnJobDefinition.VolumesProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobdefinition-volumes.html#cfn-batch-jobdefinition-volumes-name

Type:string (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnJobDefinitionProps (interface)

class @aws-cdk/aws-batch.CfnJobDefinitionProps

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobDefinitionProps;
// CfnJobDefinitionProps is an interface
import { CfnJobDefinitionProps } from '@aws-cdk/aws-batch';
type

AWS::Batch::JobDefinition.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-type

Type:string
containerProperties

AWS::Batch::JobDefinition.ContainerProperties

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-containerproperties

Type:@aws-cdk/cdk.Token or ContainerPropertiesProperty (optional)
jobDefinitionName

AWS::Batch::JobDefinition.JobDefinitionName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-jobdefinitionname

Type:string (optional)
nodeProperties

AWS::Batch::JobDefinition.NodeProperties

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-nodeproperties

Type:@aws-cdk/cdk.Token or NodePropertiesProperty (optional)
parameters

AWS::Batch::JobDefinition.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-parameters

Type:json or @aws-cdk/cdk.Token (optional)
retryStrategy

AWS::Batch::JobDefinition.RetryStrategy

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-retrystrategy

Type:@aws-cdk/cdk.Token or RetryStrategyProperty (optional)
timeout

AWS::Batch::JobDefinition.Timeout

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobdefinition.html#cfn-batch-jobdefinition-timeout

Type:@aws-cdk/cdk.Token or TimeoutProperty (optional)

CfnJobQueue

class @aws-cdk/aws-batch.CfnJobQueue(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobQueue;
const { CfnJobQueue } = require('@aws-cdk/aws-batch');
import { CfnJobQueue } from '@aws-cdk/aws-batch';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
jobQueueArn
Type:string (readonly)
propertyOverrides
Type:CfnJobQueueProps (readonly)
class ComputeEnvironmentOrderProperty

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobQueue.ComputeEnvironmentOrderProperty;
// CfnJobQueue.ComputeEnvironmentOrderProperty is an interface
import { CfnJobQueue.ComputeEnvironmentOrderProperty } from '@aws-cdk/aws-batch';
computeEnvironment

CfnJobQueue.ComputeEnvironmentOrderProperty.ComputeEnvironment

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html#cfn-batch-jobqueue-computeenvironmentorder-computeenvironment

Type:string
order

CfnJobQueue.ComputeEnvironmentOrderProperty.Order

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-batch-jobqueue-computeenvironmentorder.html#cfn-batch-jobqueue-computeenvironmentorder-order

Type:number or @aws-cdk/cdk.Token
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnJobQueueProps (interface)

class @aws-cdk/aws-batch.CfnJobQueueProps

Language-specific names:

using Amazon.CDK.AWS.Batch;
import software.amazon.awscdk.services.batch.CfnJobQueueProps;
// CfnJobQueueProps is an interface
import { CfnJobQueueProps } from '@aws-cdk/aws-batch';
computeEnvironmentOrder

AWS::Batch::JobQueue.ComputeEnvironmentOrder

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-computeenvironmentorder

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or ComputeEnvironmentOrderProperty)[]
priority

AWS::Batch::JobQueue.Priority

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-priority

Type:number or @aws-cdk/cdk.Token
jobQueueName

AWS::Batch::JobQueue.JobQueueName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobqueuename

Type:string (optional)
state

AWS::Batch::JobQueue.State

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-state

Type:string (optional)