Interface CfnRule.IBatchParametersProperty
The custom parameters to be used when the target is an AWS Batch job.
Namespace: Amazon.CDK.AWS.Events
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBatchParametersProperty
Syntax (vb)
Public Interface IBatchParametersProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Events;
var batchParametersProperty = new BatchParametersProperty {
JobDefinition = "jobDefinition",
JobName = "jobName",
// the properties below are optional
ArrayProperties = new BatchArrayPropertiesProperty {
Size = 123
},
RetryStrategy = new BatchRetryStrategyProperty {
Attempts = 123
}
};
Synopsis
Properties
Array |
The array properties for the submitted job, such as the size of the array. |
Job |
The ARN or name of the job definition to use if the event target is an AWS Batch job. |
Job |
The name to use for this execution of the job, if the target is an AWS Batch job. |
Retry |
The retry strategy to use for failed jobs, if the target is an AWS Batch job. |
Properties
ArrayProperties
The array properties for the submitted job, such as the size of the array.
virtual object ArrayProperties { get; }
Property Value
System.
Remarks
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.
JobDefinition
The ARN or name of the job definition to use if the event target is an AWS Batch job.
string JobDefinition { get; }
Property Value
System.
Remarks
This job definition must already exist.
JobName
The name to use for this execution of the job, if the target is an AWS Batch job.
string JobName { get; }
Property Value
System.
Remarks
RetryStrategy
The retry strategy to use for failed jobs, if the target is an AWS Batch job.
virtual object RetryStrategy { get; }
Property Value
System.
Remarks
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.