software.amazon.awscdk.services.batch

Class CfnJobDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.batch.CfnJobDefinition

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.57.0 (build f614666)",
           date="2022-04-22T09:30:45.532Z")
 @Stability(value=Stable)
public class CfnJobDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Batch::JobDefinition`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.batch.*;
 Object options;
 Object parameters;
 Object tags;
 CfnJobDefinition cfnJobDefinition = CfnJobDefinition.Builder.create(this, "MyCfnJobDefinition")
         .type("type")
         // the properties below are optional
         .containerProperties(ContainerPropertiesProperty.builder()
                 .image("image")
                 // the properties below are optional
                 .command(List.of("command"))
                 .environment(List.of(EnvironmentProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .executionRoleArn("executionRoleArn")
                 .fargatePlatformConfiguration(FargatePlatformConfigurationProperty.builder()
                         .platformVersion("platformVersion")
                         .build())
                 .instanceType("instanceType")
                 .jobRoleArn("jobRoleArn")
                 .linuxParameters(LinuxParametersProperty.builder()
                         .devices(List.of(DeviceProperty.builder()
                                 .containerPath("containerPath")
                                 .hostPath("hostPath")
                                 .permissions(List.of("permissions"))
                                 .build()))
                         .initProcessEnabled(false)
                         .maxSwap(123)
                         .sharedMemorySize(123)
                         .swappiness(123)
                         .tmpfs(List.of(TmpfsProperty.builder()
                                 .containerPath("containerPath")
                                 .size(123)
                                 // the properties below are optional
                                 .mountOptions(List.of("mountOptions"))
                                 .build()))
                         .build())
                 .logConfiguration(LogConfigurationProperty.builder()
                         .logDriver("logDriver")
                         // the properties below are optional
                         .options(options)
                         .secretOptions(List.of(SecretProperty.builder()
                                 .name("name")
                                 .valueFrom("valueFrom")
                                 .build()))
                         .build())
                 .memory(123)
                 .mountPoints(List.of(MountPointsProperty.builder()
                         .containerPath("containerPath")
                         .readOnly(false)
                         .sourceVolume("sourceVolume")
                         .build()))
                 .networkConfiguration(NetworkConfigurationProperty.builder()
                         .assignPublicIp("assignPublicIp")
                         .build())
                 .privileged(false)
                 .readonlyRootFilesystem(false)
                 .resourceRequirements(List.of(ResourceRequirementProperty.builder()
                         .type("type")
                         .value("value")
                         .build()))
                 .secrets(List.of(SecretProperty.builder()
                         .name("name")
                         .valueFrom("valueFrom")
                         .build()))
                 .ulimits(List.of(UlimitProperty.builder()
                         .hardLimit(123)
                         .name("name")
                         .softLimit(123)
                         .build()))
                 .user("user")
                 .vcpus(123)
                 .volumes(List.of(VolumesProperty.builder()
                         .efsVolumeConfiguration(EfsVolumeConfigurationProperty.builder()
                                 .fileSystemId("fileSystemId")
                                 // the properties below are optional
                                 .authorizationConfig(AuthorizationConfigProperty.builder()
                                         .accessPointId("accessPointId")
                                         .iam("iam")
                                         .build())
                                 .rootDirectory("rootDirectory")
                                 .transitEncryption("transitEncryption")
                                 .transitEncryptionPort(123)
                                 .build())
                         .host(VolumesHostProperty.builder()
                                 .sourcePath("sourcePath")
                                 .build())
                         .name("name")
                         .build()))
                 .build())
         .jobDefinitionName("jobDefinitionName")
         .nodeProperties(NodePropertiesProperty.builder()
                 .mainNode(123)
                 .nodeRangeProperties(List.of(NodeRangePropertyProperty.builder()
                         .targetNodes("targetNodes")
                         // the properties below are optional
                         .container(ContainerPropertiesProperty.builder()
                                 .image("image")
                                 // the properties below are optional
                                 .command(List.of("command"))
                                 .environment(List.of(EnvironmentProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .executionRoleArn("executionRoleArn")
                                 .fargatePlatformConfiguration(FargatePlatformConfigurationProperty.builder()
                                         .platformVersion("platformVersion")
                                         .build())
                                 .instanceType("instanceType")
                                 .jobRoleArn("jobRoleArn")
                                 .linuxParameters(LinuxParametersProperty.builder()
                                         .devices(List.of(DeviceProperty.builder()
                                                 .containerPath("containerPath")
                                                 .hostPath("hostPath")
                                                 .permissions(List.of("permissions"))
                                                 .build()))
                                         .initProcessEnabled(false)
                                         .maxSwap(123)
                                         .sharedMemorySize(123)
                                         .swappiness(123)
                                         .tmpfs(List.of(TmpfsProperty.builder()
                                                 .containerPath("containerPath")
                                                 .size(123)
                                                 // the properties below are optional
                                                 .mountOptions(List.of("mountOptions"))
                                                 .build()))
                                         .build())
                                 .logConfiguration(LogConfigurationProperty.builder()
                                         .logDriver("logDriver")
                                         // the properties below are optional
                                         .options(options)
                                         .secretOptions(List.of(SecretProperty.builder()
                                                 .name("name")
                                                 .valueFrom("valueFrom")
                                                 .build()))
                                         .build())
                                 .memory(123)
                                 .mountPoints(List.of(MountPointsProperty.builder()
                                         .containerPath("containerPath")
                                         .readOnly(false)
                                         .sourceVolume("sourceVolume")
                                         .build()))
                                 .networkConfiguration(NetworkConfigurationProperty.builder()
                                         .assignPublicIp("assignPublicIp")
                                         .build())
                                 .privileged(false)
                                 .readonlyRootFilesystem(false)
                                 .resourceRequirements(List.of(ResourceRequirementProperty.builder()
                                         .type("type")
                                         .value("value")
                                         .build()))
                                 .secrets(List.of(SecretProperty.builder()
                                         .name("name")
                                         .valueFrom("valueFrom")
                                         .build()))
                                 .ulimits(List.of(UlimitProperty.builder()
                                         .hardLimit(123)
                                         .name("name")
                                         .softLimit(123)
                                         .build()))
                                 .user("user")
                                 .vcpus(123)
                                 .volumes(List.of(VolumesProperty.builder()
                                         .efsVolumeConfiguration(EfsVolumeConfigurationProperty.builder()
                                                 .fileSystemId("fileSystemId")
                                                 // the properties below are optional
                                                 .authorizationConfig(AuthorizationConfigProperty.builder()
                                                         .accessPointId("accessPointId")
                                                         .iam("iam")
                                                         .build())
                                                 .rootDirectory("rootDirectory")
                                                 .transitEncryption("transitEncryption")
                                                 .transitEncryptionPort(123)
                                                 .build())
                                         .host(VolumesHostProperty.builder()
                                                 .sourcePath("sourcePath")
                                                 .build())
                                         .name("name")
                                         .build()))
                                 .build())
                         .build()))
                 .numNodes(123)
                 .build())
         .parameters(parameters)
         .platformCapabilities(List.of("platformCapabilities"))
         .propagateTags(false)
         .retryStrategy(RetryStrategyProperty.builder()
                 .attempts(123)
                 .evaluateOnExit(List.of(EvaluateOnExitProperty.builder()
                         .action("action")
                         // the properties below are optional
                         .onExitCode("onExitCode")
                         .onReason("onReason")
                         .onStatusReason("onStatusReason")
                         .build()))
                 .build())
         .schedulingPriority(123)
         .tags(tags)
         .timeout(TimeoutProperty.builder()
                 .attemptDurationSeconds(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnJobDefinition.AuthorizationConfigProperty Example:
static class	CfnJobDefinition.Builder A fluent builder for CfnJobDefinition.
static interface	CfnJobDefinition.ContainerPropertiesProperty Example:
static interface	CfnJobDefinition.DeviceProperty Example:
static interface	CfnJobDefinition.EfsVolumeConfigurationProperty Example:
static interface	CfnJobDefinition.EnvironmentProperty Example:
static interface	CfnJobDefinition.EvaluateOnExitProperty Example:
static interface	CfnJobDefinition.FargatePlatformConfigurationProperty Example:
static interface	CfnJobDefinition.LinuxParametersProperty Example:
static interface	CfnJobDefinition.LogConfigurationProperty Example:
static interface	CfnJobDefinition.MountPointsProperty Example:
static interface	CfnJobDefinition.NetworkConfigurationProperty Example:
static interface	CfnJobDefinition.NodePropertiesProperty Example:
static interface	CfnJobDefinition.NodeRangePropertyProperty Example:
static interface	CfnJobDefinition.ResourceRequirementProperty Example:
static interface	CfnJobDefinition.RetryStrategyProperty Example:
static interface	CfnJobDefinition.SecretProperty Example:
static interface	CfnJobDefinition.TimeoutProperty Example:
static interface	CfnJobDefinition.TmpfsProperty Example:
static interface	CfnJobDefinition.UlimitProperty Example:
static interface	CfnJobDefinition.VolumesHostProperty Example:
static interface	CfnJobDefinition.VolumesProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnJobDefinition(software.constructs.Construct scope, String id, CfnJobDefinitionProps props) Create a new `AWS::Batch::JobDefinition`.
protected	CfnJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getContainerProperties() `AWS::Batch::JobDefinition.ContainerProperties`.
String	getJobDefinitionName() `AWS::Batch::JobDefinition.JobDefinitionName`.
Object	getNodeProperties() `AWS::Batch::JobDefinition.NodeProperties`.
Object	getParameters() `AWS::Batch::JobDefinition.Parameters`.
List<String>	getPlatformCapabilities() `AWS::Batch::JobDefinition.PlatformCapabilities`.
Object	getPropagateTags() `AWS::Batch::JobDefinition.PropagateTags`.
Object	getRetryStrategy() `AWS::Batch::JobDefinition.RetryStrategy`.
Number	getSchedulingPriority() `AWS::Batch::JobDefinition.SchedulingPriority`.
TagManager	getTags() `AWS::Batch::JobDefinition.Tags`.
Object	getTimeout() `AWS::Batch::JobDefinition.Timeout`.
String	getType() `AWS::Batch::JobDefinition.Type`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContainerProperties(CfnJobDefinition.ContainerPropertiesProperty value) `AWS::Batch::JobDefinition.ContainerProperties`.
void	setContainerProperties(IResolvable value) `AWS::Batch::JobDefinition.ContainerProperties`.
void	setJobDefinitionName(String value) `AWS::Batch::JobDefinition.JobDefinitionName`.
void	setNodeProperties(CfnJobDefinition.NodePropertiesProperty value) `AWS::Batch::JobDefinition.NodeProperties`.
void	setNodeProperties(IResolvable value) `AWS::Batch::JobDefinition.NodeProperties`.
void	setParameters(Object value) `AWS::Batch::JobDefinition.Parameters`.
void	setPlatformCapabilities(List<String> value) `AWS::Batch::JobDefinition.PlatformCapabilities`.
void	setPropagateTags(Boolean value) `AWS::Batch::JobDefinition.PropagateTags`.
void	setPropagateTags(IResolvable value) `AWS::Batch::JobDefinition.PropagateTags`.
void	setRetryStrategy(CfnJobDefinition.RetryStrategyProperty value) `AWS::Batch::JobDefinition.RetryStrategy`.
void	setRetryStrategy(IResolvable value) `AWS::Batch::JobDefinition.RetryStrategy`.
void	setSchedulingPriority(Number value) `AWS::Batch::JobDefinition.SchedulingPriority`.
void	setTimeout(CfnJobDefinition.TimeoutProperty value) `AWS::Batch::JobDefinition.Timeout`.
void	setTimeout(IResolvable value) `AWS::Batch::JobDefinition.Timeout`.
void	setType(String value) `AWS::Batch::JobDefinition.Type`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnJobDefinition

protected CfnJobDefinition(software.amazon.jsii.JsiiObjectRef objRef)

CfnJobDefinition

protected CfnJobDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnJobDefinition

@Stability(value=Stable)
public CfnJobDefinition(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnJobDefinitionProps props)

Create a new `AWS::Batch::JobDefinition`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::Batch::JobDefinition.Tags`.

getParameters

@Stability(value=Stable)
 @NotNull
public Object getParameters()

`AWS::Batch::JobDefinition.Parameters`.

setParameters

@Stability(value=Stable)
public void setParameters(@NotNull
                                                   Object value)

`AWS::Batch::JobDefinition.Parameters`.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

`AWS::Batch::JobDefinition.Type`.

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

`AWS::Batch::JobDefinition.Type`.

getContainerProperties

@Stability(value=Stable)
 @Nullable
public Object getContainerProperties()

`AWS::Batch::JobDefinition.ContainerProperties`.

setContainerProperties

@Stability(value=Stable)
public void setContainerProperties(@Nullable
                                                            CfnJobDefinition.ContainerPropertiesProperty value)

`AWS::Batch::JobDefinition.ContainerProperties`.

setContainerProperties

@Stability(value=Stable)
public void setContainerProperties(@Nullable
                                                            IResolvable value)

`AWS::Batch::JobDefinition.ContainerProperties`.

getJobDefinitionName

@Stability(value=Stable)
 @Nullable
public String getJobDefinitionName()

`AWS::Batch::JobDefinition.JobDefinitionName`.

setJobDefinitionName

@Stability(value=Stable)
public void setJobDefinitionName(@Nullable
                                                          String value)

`AWS::Batch::JobDefinition.JobDefinitionName`.

getNodeProperties

@Stability(value=Stable)
 @Nullable
public Object getNodeProperties()

`AWS::Batch::JobDefinition.NodeProperties`.

setNodeProperties

@Stability(value=Stable)
public void setNodeProperties(@Nullable
                                                       CfnJobDefinition.NodePropertiesProperty value)

`AWS::Batch::JobDefinition.NodeProperties`.

setNodeProperties

@Stability(value=Stable)
public void setNodeProperties(@Nullable
                                                       IResolvable value)

`AWS::Batch::JobDefinition.NodeProperties`.

getPlatformCapabilities

@Stability(value=Stable)
 @Nullable
public List<String> getPlatformCapabilities()

`AWS::Batch::JobDefinition.PlatformCapabilities`.

setPlatformCapabilities

@Stability(value=Stable)
public void setPlatformCapabilities(@Nullable
                                                             List<String> value)

`AWS::Batch::JobDefinition.PlatformCapabilities`.

getPropagateTags

@Stability(value=Stable)
 @Nullable
public Object getPropagateTags()

`AWS::Batch::JobDefinition.PropagateTags`.

setPropagateTags

@Stability(value=Stable)
public void setPropagateTags(@Nullable
                                                      Boolean value)

`AWS::Batch::JobDefinition.PropagateTags`.

setPropagateTags

@Stability(value=Stable)
public void setPropagateTags(@Nullable
                                                      IResolvable value)

`AWS::Batch::JobDefinition.PropagateTags`.

getRetryStrategy

@Stability(value=Stable)
 @Nullable
public Object getRetryStrategy()

`AWS::Batch::JobDefinition.RetryStrategy`.

setRetryStrategy

@Stability(value=Stable)
public void setRetryStrategy(@Nullable
                                                      CfnJobDefinition.RetryStrategyProperty value)

`AWS::Batch::JobDefinition.RetryStrategy`.

setRetryStrategy

@Stability(value=Stable)
public void setRetryStrategy(@Nullable
                                                      IResolvable value)

`AWS::Batch::JobDefinition.RetryStrategy`.

getSchedulingPriority

@Stability(value=Stable)
 @Nullable
public Number getSchedulingPriority()

`AWS::Batch::JobDefinition.SchedulingPriority`.

setSchedulingPriority

@Stability(value=Stable)
public void setSchedulingPriority(@Nullable
                                                           Number value)

`AWS::Batch::JobDefinition.SchedulingPriority`.

getTimeout

@Stability(value=Stable)
 @Nullable
public Object getTimeout()

`AWS::Batch::JobDefinition.Timeout`.

setTimeout

@Stability(value=Stable)
public void setTimeout(@Nullable
                                                CfnJobDefinition.TimeoutProperty value)

`AWS::Batch::JobDefinition.Timeout`.

setTimeout

@Stability(value=Stable)
public void setTimeout(@Nullable
                                                IResolvable value)

`AWS::Batch::JobDefinition.Timeout`.