batchJobDefinition.md

batchJobDefinition Submodule

Constructs

BatchJobDefinition

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition aws_batch_job_definition}.

Initializers

import { batchJobDefinition } from '@cdktf/aws-cdk'

new batchJobDefinition.BatchJobDefinition(scope: Construct, id: string, config: BatchJobDefinitionConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	BatchJobDefinitionConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: BatchJobDefinitionConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
putRetryStrategy	No description.
putTimeout	No description.
resetContainerProperties	No description.
resetId	No description.
resetParameters	No description.
resetPlatformCapabilities	No description.
resetPropagateTags	No description.
resetRetryStrategy	No description.
resetTags	No description.
resetTagsAll	No description.
resetTimeout	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putRetryStrategy

public putRetryStrategy(value: BatchJobDefinitionRetryStrategy): void

value^Required

• Type: BatchJobDefinitionRetryStrategy

---

putTimeout

public putTimeout(value: BatchJobDefinitionTimeout): void

value^Required

• Type: BatchJobDefinitionTimeout

---

resetContainerProperties

public resetContainerProperties(): void

resetId

public resetId(): void

resetParameters

public resetParameters(): void

resetPlatformCapabilities

public resetPlatformCapabilities(): void

resetPropagateTags

public resetPropagateTags(): void

resetRetryStrategy

public resetRetryStrategy(): void

resetTags

public resetTags(): void

resetTagsAll

public resetTagsAll(): void

resetTimeout

public resetTimeout(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a BatchJobDefinition resource upon running "cdktf plan ".

---

isConstruct

import { batchJobDefinition } from '@cdktf/aws-cdk'

batchJobDefinition.BatchJobDefinition.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { batchJobDefinition } from '@cdktf/aws-cdk'

batchJobDefinition.BatchJobDefinition.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { batchJobDefinition } from '@cdktf/aws-cdk'

batchJobDefinition.BatchJobDefinition.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { batchJobDefinition } from '@cdktf/aws-cdk'

batchJobDefinition.BatchJobDefinition.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a BatchJobDefinition resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the BatchJobDefinition to import.

---

importFromId^Required

• Type: string

The id of the existing BatchJobDefinition that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the BatchJobDefinition to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
arn	string	No description.
retryStrategy	BatchJobDefinitionRetryStrategyOutputReference	No description.
revision	number	No description.
timeout	BatchJobDefinitionTimeoutOutputReference	No description.
containerPropertiesInput	string	No description.
idInput	string	No description.
nameInput	string	No description.
parametersInput	{[ key: string ]: string}	No description.
platformCapabilitiesInput	string[]	No description.
propagateTagsInput	boolean | cdktf.IResolvable	No description.
retryStrategyInput	BatchJobDefinitionRetryStrategy	No description.
tagsAllInput	{[ key: string ]: string}	No description.
tagsInput	{[ key: string ]: string}	No description.
timeoutInput	BatchJobDefinitionTimeout	No description.
typeInput	string	No description.
containerProperties	string	No description.
id	string	No description.
name	string	No description.
parameters	{[ key: string ]: string}	No description.
platformCapabilities	string[]	No description.
propagateTags	boolean | cdktf.IResolvable	No description.
tags	{[ key: string ]: string}	No description.
tagsAll	{[ key: string ]: string}	No description.
type	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

arn^Required

public readonly arn: string;

• Type: string

---

retryStrategy^Required

public readonly retryStrategy: BatchJobDefinitionRetryStrategyOutputReference;

• Type: BatchJobDefinitionRetryStrategyOutputReference

---

revision^Required

public readonly revision: number;

• Type: number

---

timeout^Required

public readonly timeout: BatchJobDefinitionTimeoutOutputReference;

• Type: BatchJobDefinitionTimeoutOutputReference

---

containerPropertiesInput^Optional

public readonly containerPropertiesInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

parametersInput^Optional

public readonly parametersInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

platformCapabilitiesInput^Optional

public readonly platformCapabilitiesInput: string[];

• Type: string[]

---

propagateTagsInput^Optional

public readonly propagateTagsInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

retryStrategyInput^Optional

public readonly retryStrategyInput: BatchJobDefinitionRetryStrategy;

• Type: BatchJobDefinitionRetryStrategy

---

tagsAllInput^Optional

public readonly tagsAllInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsInput^Optional

public readonly tagsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

timeoutInput^Optional

public readonly timeoutInput: BatchJobDefinitionTimeout;

• Type: BatchJobDefinitionTimeout

---

typeInput^Optional

public readonly typeInput: string;

• Type: string

---

containerProperties^Required

public readonly containerProperties: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

parameters^Required

public readonly parameters: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

platformCapabilities^Required

public readonly platformCapabilities: string[];

• Type: string[]

---

propagateTags^Required

public readonly propagateTags: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

tags^Required

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

tagsAll^Required

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

type^Required

public readonly type: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

BatchJobDefinitionConfig

Initializer

import { batchJobDefinition } from '@cdktf/aws-cdk'

const batchJobDefinitionConfig: batchJobDefinition.BatchJobDefinitionConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
name	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#name BatchJobDefinition#name}.
type	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#type BatchJobDefinition#type}.
containerProperties	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#container_properties BatchJobDefinition#container_properties}.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#id BatchJobDefinition#id}.
parameters	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#parameters BatchJobDefinition#parameters}.
platformCapabilities	string[]	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#platform_capabilities BatchJobDefinition#platform_capabilities}.
propagateTags	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#propagate_tags BatchJobDefinition#propagate_tags}.
retryStrategy	BatchJobDefinitionRetryStrategy	retry_strategy block.
tags	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#tags BatchJobDefinition#tags}.
tagsAll	{[ key: string ]: string}	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#tags_all BatchJobDefinition#tags_all}.
timeout	BatchJobDefinitionTimeout	timeout block.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

name^Required

public readonly name: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#name BatchJobDefinition#name}.

---

type^Required

public readonly type: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#type BatchJobDefinition#type}.

---

containerProperties^Optional

public readonly containerProperties: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#container_properties BatchJobDefinition#container_properties}.

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#id BatchJobDefinition#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

parameters^Optional

public readonly parameters: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#parameters BatchJobDefinition#parameters}.

---

platformCapabilities^Optional

public readonly platformCapabilities: string[];

• Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#platform_capabilities BatchJobDefinition#platform_capabilities}.

---

propagateTags^Optional

public readonly propagateTags: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#propagate_tags BatchJobDefinition#propagate_tags}.

---

retryStrategy^Optional

public readonly retryStrategy: BatchJobDefinitionRetryStrategy;

• Type: BatchJobDefinitionRetryStrategy

retry_strategy block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#retry_strategy BatchJobDefinition#retry_strategy}

---

tags^Optional

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#tags BatchJobDefinition#tags}.

---

tagsAll^Optional

public readonly tagsAll: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#tags_all BatchJobDefinition#tags_all}.

---

timeout^Optional

public readonly timeout: BatchJobDefinitionTimeout;

• Type: BatchJobDefinitionTimeout

timeout block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#timeout BatchJobDefinition#timeout}

---

BatchJobDefinitionRetryStrategy

Initializer

import { batchJobDefinition } from '@cdktf/aws-cdk'

const batchJobDefinitionRetryStrategy: batchJobDefinition.BatchJobDefinitionRetryStrategy = { ... }

Properties

Name	Type	Description
attempts	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#attempts BatchJobDefinition#attempts}.
evaluateOnExit	cdktf.IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit[]	evaluate_on_exit block.

---

attempts^Optional

public readonly attempts: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#attempts BatchJobDefinition#attempts}.

---

evaluateOnExit^Optional

public readonly evaluateOnExit: IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit[];

• Type: cdktf.IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit[]

evaluate_on_exit block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#evaluate_on_exit BatchJobDefinition#evaluate_on_exit}

---

BatchJobDefinitionRetryStrategyEvaluateOnExit

Initializer

import { batchJobDefinition } from '@cdktf/aws-cdk'

const batchJobDefinitionRetryStrategyEvaluateOnExit: batchJobDefinition.BatchJobDefinitionRetryStrategyEvaluateOnExit = { ... }

Properties

Name	Type	Description
action	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#action BatchJobDefinition#action}.
onExitCode	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#on_exit_code BatchJobDefinition#on_exit_code}.
onReason	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#on_reason BatchJobDefinition#on_reason}.
onStatusReason	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#on_status_reason BatchJobDefinition#on_status_reason}.

---

action^Required

public readonly action: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#action BatchJobDefinition#action}.

---

onExitCode^Optional

public readonly onExitCode: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#on_exit_code BatchJobDefinition#on_exit_code}.

---

onReason^Optional

public readonly onReason: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#on_reason BatchJobDefinition#on_reason}.

---

onStatusReason^Optional

public readonly onStatusReason: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#on_status_reason BatchJobDefinition#on_status_reason}.

---

BatchJobDefinitionTimeout

Initializer

import { batchJobDefinition } from '@cdktf/aws-cdk'

const batchJobDefinitionTimeout: batchJobDefinition.BatchJobDefinitionTimeout = { ... }

Properties

Name	Type	Description
attemptDurationSeconds	number	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#attempt_duration_seconds BatchJobDefinition#attempt_duration_seconds}.

---

attemptDurationSeconds^Optional

public readonly attemptDurationSeconds: number;

• Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/batch_job_definition#attempt_duration_seconds BatchJobDefinition#attempt_duration_seconds}.

---

Classes

BatchJobDefinitionRetryStrategyEvaluateOnExitList

Initializers

import { batchJobDefinition } from '@cdktf/aws-cdk'

new batchJobDefinition.BatchJobDefinitionRetryStrategyEvaluateOnExitList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): BatchJobDefinitionRetryStrategyEvaluateOnExitOutputReference

index^Required

• Type: number

the index of the item to return.

---

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
internalValue	cdktf.IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit[]	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit[];

• Type: cdktf.IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit[]

---

BatchJobDefinitionRetryStrategyEvaluateOnExitOutputReference

Initializers

import { batchJobDefinition } from '@cdktf/aws-cdk'

new batchJobDefinition.BatchJobDefinitionRetryStrategyEvaluateOnExitOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetOnExitCode	No description.
resetOnReason	No description.
resetOnStatusReason	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetOnExitCode

public resetOnExitCode(): void

resetOnReason

public resetOnReason(): void

resetOnStatusReason

public resetOnStatusReason(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
actionInput	string	No description.
onExitCodeInput	string	No description.
onReasonInput	string	No description.
onStatusReasonInput	string	No description.
action	string	No description.
onExitCode	string	No description.
onReason	string	No description.
onStatusReason	string	No description.
internalValue	cdktf.IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

actionInput^Optional

public readonly actionInput: string;

• Type: string

---

onExitCodeInput^Optional

public readonly onExitCodeInput: string;

• Type: string

---

onReasonInput^Optional

public readonly onReasonInput: string;

• Type: string

---

onStatusReasonInput^Optional

public readonly onStatusReasonInput: string;

• Type: string

---

action^Required

public readonly action: string;

• Type: string

---

onExitCode^Required

public readonly onExitCode: string;

• Type: string

---

onReason^Required

public readonly onReason: string;

• Type: string

---

onStatusReason^Required

public readonly onStatusReason: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit;

• Type: cdktf.IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit

---

BatchJobDefinitionRetryStrategyOutputReference

Initializers

import { batchJobDefinition } from '@cdktf/aws-cdk'

new batchJobDefinition.BatchJobDefinitionRetryStrategyOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
putEvaluateOnExit	No description.
resetAttempts	No description.
resetEvaluateOnExit	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

putEvaluateOnExit

public putEvaluateOnExit(value: IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit[]): void

value^Required

• Type: cdktf.IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit[]

---

resetAttempts

public resetAttempts(): void

resetEvaluateOnExit

public resetEvaluateOnExit(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
evaluateOnExit	BatchJobDefinitionRetryStrategyEvaluateOnExitList	No description.
attemptsInput	number	No description.
evaluateOnExitInput	cdktf.IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit[]	No description.
attempts	number	No description.
internalValue	BatchJobDefinitionRetryStrategy	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

evaluateOnExit^Required

public readonly evaluateOnExit: BatchJobDefinitionRetryStrategyEvaluateOnExitList;

• Type: BatchJobDefinitionRetryStrategyEvaluateOnExitList

---

attemptsInput^Optional

public readonly attemptsInput: number;

• Type: number

---

evaluateOnExitInput^Optional

public readonly evaluateOnExitInput: IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit[];

• Type: cdktf.IResolvable | BatchJobDefinitionRetryStrategyEvaluateOnExit[]

---

attempts^Required

public readonly attempts: number;

• Type: number

---

internalValue^Optional

public readonly internalValue: BatchJobDefinitionRetryStrategy;

• Type: BatchJobDefinitionRetryStrategy

---

BatchJobDefinitionTimeoutOutputReference

Initializers

import { batchJobDefinition } from '@cdktf/aws-cdk'

new batchJobDefinition.BatchJobDefinitionTimeoutOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetAttemptDurationSeconds	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetAttemptDurationSeconds

public resetAttemptDurationSeconds(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
attemptDurationSecondsInput	number	No description.
attemptDurationSeconds	number	No description.
internalValue	BatchJobDefinitionTimeout	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

attemptDurationSecondsInput^Optional

public readonly attemptDurationSecondsInput: number;

• Type: number

---

attemptDurationSeconds^Required

public readonly attemptDurationSeconds: number;

• Type: number

---

internalValue^Optional

public readonly internalValue: BatchJobDefinitionTimeout;

• Type: BatchJobDefinitionTimeout

---