java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.tasks.BatchSubmitJobProps.Jsii$Proxy

All Implemented Interfaces:: AssignableStateOptions, JsonataCommonOptions, JsonPathCommonOptions, StateBaseProps, BatchSubmitJobProps, TaskStateBaseOptions, TaskStateBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: BatchSubmitJobProps

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

An implementation for 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

Constructors

Modifier

Constructor

Description

protected

Jsii$Proxy(BatchSubmitJobProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the BatchSubmitJobProps.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 Number

getArraySize()

The array size can be between 2 and 10,000.

final Map<String,Object>

getAssign()

Workflow variables to store in this step.

final Number

getAttempts()

The number of times to move a job to the RUNNABLE status.

final String

getComment()

A comment describing this state.

final BatchContainerOverrides

getContainerOverrides()

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

getCredentials()

Credentials for an IAM Role that the State Machine assumes for executing the task.

final List<BatchJobDependency>

getDependsOn()

A list of dependencies for the job.

final Duration

getHeartbeat()

(deprecated) Timeout for the heartbeat.

final Timeout

getHeartbeatTimeout()

Timeout for the heartbeat.

final String

getInputPath()

JSONPath expression to select part of the state to be the input to this state.

final IntegrationPattern

getIntegrationPattern()

AWS Step Functions integrates with services directly in the Amazon States Language.

final String

getJobDefinitionArn()

The arn of the job definition used by this job.

final String

getJobName()

The name of the job.

final String

getJobQueueArn()

The arn of the job queue into which the job is submitted.

final String

getOutputPath()

JSONPath expression to select part of the state to be the output to this state.

final Object

getOutputs()

Used to specify and transform output from the state.

final TaskInput

getPayload()

The payload to be passed as parameters to the batch job.

final QueryLanguage

getQueryLanguage()

The name of the query language used by the state.

final String

getResultPath()

JSONPath expression to indicate where to inject the state's output.

final Map<String,Object>

getResultSelector()

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

final String

getStateName()

Optional name for this state.

final Map<String,String>

getTags()

The tags applied to the job request.

final Timeout

getTaskTimeout()

Timeout for the task.

final Duration

getTimeout()

(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

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(BatchSubmitJobProps.Builder builder)
  
  Constructor that initializes the object based on literal property values passed by the BatchSubmitJobProps.Builder.
Method Details
- getJobDefinitionArn
  
  public final String getJobDefinitionArn()
  
  Description copied from interface: BatchSubmitJobProps
  
  The arn of the job definition used by this job.
  
  Specified by:
  
  getJobDefinitionArn in interface BatchSubmitJobProps
- getJobName
  
  public final String 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 interface BatchSubmitJobProps
- getJobQueueArn
  
  public final String getJobQueueArn()
  
  Description copied from interface: BatchSubmitJobProps
  
  The arn of the job queue into which the job is submitted.
  
  Specified by:
  
  getJobQueueArn in interface BatchSubmitJobProps
- getArraySize
  
  public final Number 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 interface BatchSubmitJobProps
- getAttempts
  
  public final Number 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 interface BatchSubmitJobProps
- getContainerOverrides
  
  public final BatchContainerOverrides 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 interface BatchSubmitJobProps
  
  See Also:
  
  https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-containerOverrides
- getDependsOn
  
  public final List<BatchJobDependency> 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 interface BatchSubmitJobProps
  
  See Also:
  
  https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html#Batch-SubmitJob-request-dependsOn
- getPayload
  
  public final TaskInput 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 interface BatchSubmitJobProps
- getTags
  
  public final Map<String,String> getTags()
  
  Description copied from interface: BatchSubmitJobProps
  
  The tags applied to the job request.
  Default: {} - no tags
  
  Specified by:
  
  getTags in interface BatchSubmitJobProps
- getResultPath
  
  public final String 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: $
  
  Specified by:
  
  getResultPath in interface TaskStateBaseProps
- getResultSelector
  
  public final Map<String,Object> 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 interface TaskStateBaseProps
  
  See Also:
  
  https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector
- getComment
  
  public final String getComment()
  
  Description copied from interface: StateBaseProps
  
  A comment describing this state.
  Default: No comment
  
  Specified by:
  
  getComment in interface StateBaseProps
- getQueryLanguage
  
  public final QueryLanguage getQueryLanguage()
  
  Description copied from interface: StateBaseProps
  
  The name of the query language used by the state.
  If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
  Default: - JSONPath
  
  Specified by:
  
  getQueryLanguage in interface StateBaseProps
- getStateName
  
  public final String getStateName()
  
  Description copied from interface: StateBaseProps
  
  Optional name for this state.
  Default: - The construct ID will be used as state name
  
  Specified by:
  
  getStateName in interface StateBaseProps
- getCredentials
  
  public final Credentials getCredentials()
  
  Description copied from interface: TaskStateBaseOptions
  
  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 interface TaskStateBaseOptions
  
  See Also:
  
  https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
- getHeartbeat
  
  public final Duration getHeartbeat()
  
  Description copied from interface: TaskStateBaseOptions
  
  (deprecated) Timeout for the heartbeat.
  Default: - None
  
  Specified by:
  
  getHeartbeat in interface TaskStateBaseOptions
- getHeartbeatTimeout
  
  public final Timeout getHeartbeatTimeout()
  
  Description copied from interface: TaskStateBaseOptions
  
  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 interface TaskStateBaseOptions
- getIntegrationPattern
  
  public final IntegrationPattern getIntegrationPattern()
  
  Description copied from interface: TaskStateBaseOptions
  
  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 interface TaskStateBaseOptions
  
  See Also:
  
  https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html
- getTaskTimeout
  
  public final Timeout getTaskTimeout()
  
  Description copied from interface: TaskStateBaseOptions
  
  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 interface TaskStateBaseOptions
- getTimeout
  
  public final Duration getTimeout()
  
  Description copied from interface: TaskStateBaseOptions
  
  (deprecated) Timeout for the task.
  Default: - None
  
  Specified by:
  
  getTimeout in interface TaskStateBaseOptions
- getAssign
  
  public final Map<String,Object> getAssign()
  
  Description copied from interface: AssignableStateOptions
  
  Workflow variables to store in this step.
  Using workflow variables, you can store data in a step and retrieve that data in future steps.
  Default: - Not assign variables
  Specified by:
  
  getAssign in interface AssignableStateOptions
  
  See Also:
  
  https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html
- getInputPath
  
  public final String getInputPath()
  
  Description copied from interface: JsonPathCommonOptions
  
  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: $
  
  Specified by:
  
  getInputPath in interface JsonPathCommonOptions
- getOutputPath
  
  public final String getOutputPath()
  
  Description copied from interface: JsonPathCommonOptions
  
  JSONPath expression to select part of the state to be the output to this state.
  May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
  Default: $
  
  Specified by:
  
  getOutputPath in interface JsonPathCommonOptions
- getOutputs
  
  public final Object getOutputs()
  
  Description copied from interface: JsonataCommonOptions
  
  Used to specify and transform output from the state.
  When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.
  Default: - $states.result or $states.errorOutput
  Specified by:
  
  getOutputs in interface JsonataCommonOptions
  
  See Also:
  
  https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html
- $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

Class BatchSubmitJobProps.Jsii$Proxy

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.tasks.BatchSubmitJobProps

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Details

Jsii$Proxy

Jsii$Proxy

Method Details

getJobDefinitionArn

getJobName

getJobQueueArn

getArraySize

getAttempts

getContainerOverrides

getDependsOn

getPayload

getTags

getResultPath

getResultSelector

getComment

getQueryLanguage

getStateName

getCredentials

getHeartbeat

getHeartbeatTimeout

getIntegrationPattern

getTaskTimeout

getTimeout

getAssign

getInputPath

getOutputPath

getOutputs

$jsii$toJson

equals

hashCode