Class BatchSubmitJobProps.Jsii$Proxy
- All Implemented Interfaces:
BatchSubmitJobProps
,TaskStateBaseProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
BatchSubmitJobProps
BatchSubmitJobProps
-
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.stepfunctions.tasks.BatchSubmitJobProps
BatchSubmitJobProps.Builder, BatchSubmitJobProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Jsii$Proxy
(BatchSubmitJobProps.Builder builder) Constructor that initializes the object based on literal property values passed by theBatchSubmitJobProps.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 TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Number
The array size can be between 2 and 10,000.final Number
The number of times to move a job to the RUNNABLE status.final String
An optional description for this state.final BatchContainerOverrides
A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.final Credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.final List<BatchJobDependency>
A list of dependencies for the job.final Duration
(deprecated) Timeout for the heartbeat.final Timeout
Timeout for the heartbeat.final String
JSONPath expression to select part of the state to be the input to this state.final IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.final String
The arn of the job definition used by this job.final String
The name of the job.final String
The arn of the job queue into which the job is submitted.final String
JSONPath expression to select select a portion of the state output to pass to the next state.final TaskInput
The payload to be passed as parameters to the batch job.final String
JSONPath expression to indicate where to inject the state's output.The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.final String
Optional name for this state.getTags()
The tags applied to the job request.final Timeout
Timeout for the task.final Duration
(deprecated) Timeout for the task.final int
hashCode()
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
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
Constructor that initializes the object based on literal property values passed by theBatchSubmitJobProps.Builder
.
-
-
Method Details
-
getJobDefinitionArn
Description copied from interface:BatchSubmitJobProps
The arn of the job definition used by this job.- Specified by:
getJobDefinitionArn
in interfaceBatchSubmitJobProps
-
getJobName
Description copied from interface:BatchSubmitJobProps
The name of the job.The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
- Specified by:
getJobName
in interfaceBatchSubmitJobProps
-
getJobQueueArn
Description copied from interface:BatchSubmitJobProps
The arn of the job queue into which the job is submitted.- Specified by:
getJobQueueArn
in interfaceBatchSubmitJobProps
-
getArraySize
Description copied from interface:BatchSubmitJobProps
The array size can be between 2 and 10,000.If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the AWS Batch User Guide.
Default: - No array size
- Specified by:
getArraySize
in interfaceBatchSubmitJobProps
-
getAttempts
Description copied from interface:BatchSubmitJobProps
The number of times to move a job to the RUNNABLE status.You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
Default: 1
- Specified by:
getAttempts
in interfaceBatchSubmitJobProps
-
getContainerOverrides
Description copied from interface:BatchSubmitJobProps
A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive.Default: - No container overrides
- Specified by:
getContainerOverrides
in interfaceBatchSubmitJobProps
- See Also:
-
getDependsOn
Description copied from interface:BatchSubmitJobProps
A list of dependencies for the job.A job can depend upon a maximum of 20 jobs.
Default: - No dependencies
- Specified by:
getDependsOn
in interfaceBatchSubmitJobProps
- See Also:
-
getPayload
Description copied from interface:BatchSubmitJobProps
The payload to be passed as parameters to the batch job.Default: - No parameters are passed
- Specified by:
getPayload
in interfaceBatchSubmitJobProps
-
getTags
Description copied from interface:BatchSubmitJobProps
The tags applied to the job request.Default: {} - no tags
- Specified by:
getTags
in interfaceBatchSubmitJobProps
-
getComment
Description copied from interface:TaskStateBaseProps
An optional description for this state.Default: - No comment
- Specified by:
getComment
in interfaceTaskStateBaseProps
-
getCredentials
Description copied from interface:TaskStateBaseProps
Credentials for an IAM Role that the State Machine assumes for executing the task.This enables cross-account resource invocations.
Default: - None (Task is executed using the State Machine's execution role)
- Specified by:
getCredentials
in interfaceTaskStateBaseProps
- See Also:
-
getHeartbeat
Description copied from interface:TaskStateBaseProps
(deprecated) Timeout for the heartbeat.Default: - None
- Specified by:
getHeartbeat
in interfaceTaskStateBaseProps
-
getHeartbeatTimeout
Description copied from interface:TaskStateBaseProps
Timeout for the heartbeat.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Specified by:
getHeartbeatTimeout
in interfaceTaskStateBaseProps
-
getInputPath
Description copied from interface:TaskStateBaseProps
JSONPath expression to select part of the state to be the input to this state.May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: - The entire task input (JSON path '$')
- Specified by:
getInputPath
in interfaceTaskStateBaseProps
-
getIntegrationPattern
Description copied from interface:TaskStateBaseProps
AWS Step Functions integrates with services directly in the Amazon States Language.You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.
- Specified by:
getIntegrationPattern
in interfaceTaskStateBaseProps
- See Also:
-
getOutputPath
Description copied from interface:TaskStateBaseProps
JSONPath expression to select select a portion of the state output to pass to the next state.May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')
- Specified by:
getOutputPath
in interfaceTaskStateBaseProps
-
getResultPath
Description copied from interface:TaskStateBaseProps
JSONPath expression to indicate where to inject the state's output.May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
Default: - Replaces the entire input with the result (JSON path '$')
- Specified by:
getResultPath
in interfaceTaskStateBaseProps
-
getResultSelector
Description copied from interface:TaskStateBaseProps
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None
- Specified by:
getResultSelector
in interfaceTaskStateBaseProps
- See Also:
-
getStateName
Description copied from interface:TaskStateBaseProps
Optional name for this state.Default: - The construct ID will be used as state name
- Specified by:
getStateName
in interfaceTaskStateBaseProps
-
getTaskTimeout
Description copied from interface:TaskStateBaseProps
Timeout for the task.[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
- Specified by:
getTaskTimeout
in interfaceTaskStateBaseProps
-
getTimeout
Description copied from interface:TaskStateBaseProps
(deprecated) Timeout for the task.Default: - None
- Specified by:
getTimeout
in interfaceTaskStateBaseProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-