Package software.amazon.awscdk.services.batch

Class CfnJobDefinitionProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.batch.CfnJobDefinitionProps.Jsii$Proxy

All Implemented Interfaces:

CfnJobDefinitionProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnJobDefinitionProps

@Stability(Stable)
@Internal
public static final class CfnJobDefinitionProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnJobDefinitionProps

An implementation for CfnJobDefinitionProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.CfnJobDefinitionProps

CfnJobDefinitionProps.Builder, CfnJobDefinitionProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnJobDefinitionProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnJobDefinitionProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getConsumableResourceProperties()	Contains a list of consumable resources required by the job.
final Object	getContainerProperties()	An object with properties specific to Amazon ECS-based jobs.
final Object	getEcsProperties()	An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties , eksProperties , or nodeProperties .
final Object	getEksProperties()	An object with properties that are specific to Amazon EKS-based jobs.
final String	getJobDefinitionName()	The name of the job definition.
final Object	getNodeProperties()	An object with properties that are specific to multi-node parallel jobs.
final Object	getParameters()	Default parameters or parameter substitution placeholders that are set in the job definition.
final List<String>	getPlatformCapabilities()	The platform capabilities required by the job definition.
final Object	getPropagateTags()	Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.
final Object	getResourceRetentionPolicy()	Specifies the resource retention policy settings for the job definition.
final Object	getRetryStrategy()	The retry strategy to use for failed jobs that are submitted with this job definition.
final Number	getSchedulingPriority()	The scheduling priority of the job definition.
final Object	getTags()	The tags that are applied to the job definition.
final Object	getTimeout()	The timeout time for jobs that are submitted with this job definition.
final String	getType()	The type of job definition.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnJobDefinitionProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnJobDefinitionProps.Builder.

Method Details

getType

public final String getType()

Description copied from interface: CfnJobDefinitionProps

The type of job definition.

For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the AWS Batch User Guide .

• If the value is container , then one of the following is required: containerProperties , ecsProperties , or eksProperties .
• If the value is multinode , then nodeProperties is required.

If the job is run on Fargate resources, then multinode isn't supported.

Specified by:

getType in interface CfnJobDefinitionProps

See Also:

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

getConsumableResourceProperties

public final Object getConsumableResourceProperties()

Description copied from interface: CfnJobDefinitionProps

Contains a list of consumable resources required by the job.

Returns union: either IResolvable or CfnJobDefinition.ConsumableResourcePropertiesProperty

Specified by:

getConsumableResourceProperties in interface CfnJobDefinitionProps

See Also:

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

getContainerProperties

public final Object getContainerProperties()

Description copied from interface: CfnJobDefinitionProps

An object with properties specific to Amazon ECS-based jobs.

When containerProperties is used in the job definition, it can't be used in addition to eksProperties , ecsProperties , or nodeProperties .

Returns union: either IResolvable or CfnJobDefinition.ContainerPropertiesProperty

Specified by:

getContainerProperties in interface CfnJobDefinitionProps

See Also:

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

getEcsProperties

public final Object getEcsProperties()

Description copied from interface: CfnJobDefinitionProps

An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties , eksProperties , or nodeProperties .

Returns union: either IResolvable or CfnJobDefinition.EcsPropertiesProperty

Specified by:

getEcsProperties in interface CfnJobDefinitionProps

See Also:

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

getEksProperties

public final Object getEksProperties()

Description copied from interface: CfnJobDefinitionProps

An object with properties that are specific to Amazon EKS-based jobs.

When eksProperties is used in the job definition, it can't be used in addition to containerProperties , ecsProperties , or nodeProperties .

Returns union: either IResolvable or CfnJobDefinition.EksPropertiesProperty

Specified by:

getEksProperties in interface CfnJobDefinitionProps

See Also:

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

getJobDefinitionName

public final String getJobDefinitionName()

Description copied from interface: CfnJobDefinitionProps

The name of the job definition.

Specified by:

getJobDefinitionName in interface CfnJobDefinitionProps

See Also:

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

getNodeProperties

public final Object getNodeProperties()

Description copied from interface: CfnJobDefinitionProps

An object with properties that are specific to multi-node parallel jobs.

When nodeProperties is used in the job definition, it can't be used in addition to containerProperties , ecsProperties , or eksProperties .

If the job runs on Fargate resources, don't specify nodeProperties . Use containerProperties instead.

Returns union: either IResolvable or CfnJobDefinition.NodePropertiesProperty

Specified by:

getNodeProperties in interface CfnJobDefinitionProps

See Also:

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

getParameters

public final Object getParameters()

Description copied from interface: CfnJobDefinitionProps

Default parameters or parameter substitution placeholders that are set in the job definition.

Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the AWS Batch User Guide .

Specified by:

getParameters in interface CfnJobDefinitionProps

See Also:

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

getPlatformCapabilities

public final List<String> getPlatformCapabilities()

Description copied from interface: CfnJobDefinitionProps

The platform capabilities required by the job definition.

If no value is specified, it defaults to EC2 . Jobs run on Fargate resources specify FARGATE .

Specified by:

getPlatformCapabilities in interface CfnJobDefinitionProps

See Also:

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

getPropagateTags

public final Object getPropagateTags()

Description copied from interface: CfnJobDefinitionProps

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task.

If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Returns union: either Boolean or IResolvable

Specified by:

getPropagateTags in interface CfnJobDefinitionProps

See Also:

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

getResourceRetentionPolicy

public final Object getResourceRetentionPolicy()

Description copied from interface: CfnJobDefinitionProps

Specifies the resource retention policy settings for the job definition.

Returns union: either IResolvable or CfnJobDefinition.ResourceRetentionPolicyProperty

Specified by:

getResourceRetentionPolicy in interface CfnJobDefinitionProps

See Also:

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

getRetryStrategy

public final Object getRetryStrategy()

Description copied from interface: CfnJobDefinitionProps

The retry strategy to use for failed jobs that are submitted with this job definition.

Returns union: either IResolvable or CfnJobDefinition.RetryStrategyProperty

Specified by:

getRetryStrategy in interface CfnJobDefinitionProps

See Also:

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

getSchedulingPriority

public final Number getSchedulingPriority()

Description copied from interface: CfnJobDefinitionProps

The scheduling priority of the job definition.

This only affects jobs in job queues with a fair-share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

Specified by:

getSchedulingPriority in interface CfnJobDefinitionProps

See Also:

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

getTags

public final Object getTags()

Description copied from interface: CfnJobDefinitionProps

The tags that are applied to the job definition.

Specified by:

getTags in interface CfnJobDefinitionProps

See Also:

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

getTimeout

public final Object getTimeout()

Description copied from interface: CfnJobDefinitionProps

The timeout time for jobs that are submitted with this job definition.

After the amount of time you specify passes, AWS Batch terminates your jobs if they aren't finished.

Returns union: either IResolvable or CfnJobDefinition.TimeoutProperty

Specified by:

getTimeout in interface CfnJobDefinitionProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object