Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeTargetBatchJobParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.PipeTargetBatchJobParametersProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.PipeTargetBatchJobParametersProperty
extends software.amazon.jsii.JsiiSerializable

The parameters for using an AWS Batch job as a target.

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.pipes.*;
 PipeTargetBatchJobParametersProperty pipeTargetBatchJobParametersProperty = PipeTargetBatchJobParametersProperty.builder()
         .jobDefinition("jobDefinition")
         .jobName("jobName")
         // the properties below are optional
         .arrayProperties(BatchArrayPropertiesProperty.builder()
                 .size(123)
                 .build())
         .containerOverrides(BatchContainerOverridesProperty.builder()
                 .command(List.of("command"))
                 .environment(List.of(BatchEnvironmentVariableProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .instanceType("instanceType")
                 .resourceRequirements(List.of(BatchResourceRequirementProperty.builder()
                         .type("type")
                         .value("value")
                         .build()))
                 .build())
         .dependsOn(List.of(BatchJobDependencyProperty.builder()
                 .jobId("jobId")
                 .type("type")
                 .build()))
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .retryStrategy(BatchRetryStrategyProperty.builder()
                 .attempts(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipe.PipeTargetBatchJobParametersProperty.Builder	A builder for CfnPipe.PipeTargetBatchJobParametersProperty
static final class	CfnPipe.PipeTargetBatchJobParametersProperty.Jsii$Proxy	An implementation for CfnPipe.PipeTargetBatchJobParametersProperty

Method Summary

Modifier and Type	Method	Description
static CfnPipe.PipeTargetBatchJobParametersProperty.Builder	builder()
default Object	getArrayProperties()	The array properties for the submitted job, such as the size of the array.
default Object	getContainerOverrides()	The overrides that are sent to a container.
default Object	getDependsOn()	A list of dependencies for the job.
String	getJobDefinition()	The job definition used by this job.
String	getJobName()	The name of the job.
default Object	getParameters()	Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition.
default Object	getRetryStrategy()	The retry strategy to use for failed jobs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-jobdefinition

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 (_).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-jobname

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-arrayproperties

getContainerOverrides

@Stability(Stable)
@Nullable
default Object getContainerOverrides()

The overrides that are sent to a container.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-containeroverrides

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-dependson

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-parameters

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetbatchjobparameters.html#cfn-pipes-pipe-pipetargetbatchjobparameters-retrystrategy

builder

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

Returns:

a CfnPipe.PipeTargetBatchJobParametersProperty.Builder of CfnPipe.PipeTargetBatchJobParametersProperty