Interface CfnPipe.PipeTargetBatchJobParametersProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnPipe.PipeTargetBatchJobParametersProperty extends
The parameters for using an AWS Batch job as a target.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 PipeTargetBatchJobParametersProperty pipeTargetBatchJobParametersProperty = PipeTargetBatchJobParametersProperty.builder()
         // the properties below are optional
                 "parametersKey", "parameters"))
  • Method Details

    • getJobDefinition

      @Stability(Stable) @NotNull String getJobDefinition()
      The job definition used by this job.

      This value can be one of name , name:revision , or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

    • getJobName

      @Stability(Stable) @NotNull String getJobName()
      The name of the job.

      It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

    • getArrayProperties

      @Stability(Stable) @Nullable default Object getArrayProperties()
      The array properties for the submitted job, such as the size of the array.

      The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.

    • getContainerOverrides

      @Stability(Stable) @Nullable default Object getContainerOverrides()
      The overrides that are sent to a container.
    • getDependsOn

      @Stability(Stable) @Nullable default Object getDependsOn()
      A list of dependencies for the job.

      A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

    • getParameters

      @Stability(Stable) @Nullable default Object getParameters()
      Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.

      Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.

    • getRetryStrategy

      @Stability(Stable) @Nullable default Object getRetryStrategy()
      The retry strategy to use for failed jobs.

      When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

    • builder

      @Stability(Stable) static CfnPipe.PipeTargetBatchJobParametersProperty.Builder builder()
      a CfnPipe.PipeTargetBatchJobParametersProperty.Builder of CfnPipe.PipeTargetBatchJobParametersProperty