Package software.amazon.awscdk.services.events

Interface CfnRule.BatchParametersProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRule.BatchParametersProperty.Jsii$Proxy

Enclosing class:

CfnRule

@Stability(Stable)
public static interface CfnRule.BatchParametersProperty
extends software.amazon.jsii.JsiiSerializable

The custom parameters to be used when the target is an AWS Batch job.

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.events.*;
 BatchParametersProperty batchParametersProperty = BatchParametersProperty.builder()
         .jobDefinition("jobDefinition")
         .jobName("jobName")
         // the properties below are optional
         .arrayProperties(BatchArrayPropertiesProperty.builder()
                 .size(123)
                 .build())
         .retryStrategy(BatchRetryStrategyProperty.builder()
                 .attempts(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRule.BatchParametersProperty.Builder	builder()
default Object	getArrayProperties()	The array properties for the submitted job, such as the size of the array.
String	getJobDefinition()	The ARN or name of the job definition to use if the event target is an AWS Batch job.
String	getJobName()	The name to use for this execution of the job, if the target is an AWS Batch job.
default Object	getRetryStrategy()	The retry strategy to use for failed jobs, if the target is an AWS Batch job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getJobDefinition

@Stability(Stable)
@NotNull
String getJobDefinition()

The ARN or name of the job definition to use if the event target is an AWS Batch job.

This job definition must already exist.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-jobdefinition

getJobName

@Stability(Stable)
@NotNull
String getJobName()

The name to use for this execution of the job, if the target is an AWS Batch job.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-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-events-rule-batchparameters.html#cfn-events-rule-batchparameters-arrayproperties

getRetryStrategy

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

The retry strategy to use for failed jobs, if the target is an AWS Batch job.

The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-events-rule-batchparameters.html#cfn-events-rule-batchparameters-retrystrategy

builder

@Stability(Stable)
static CfnRule.BatchParametersProperty.Builder builder()

Returns:

a CfnRule.BatchParametersProperty.Builder of CfnRule.BatchParametersProperty