Class: Aws::EventBridge::Types::BatchParameters
- Inherits:
-
Struct
- Object
- Struct
- Aws::EventBridge::Types::BatchParameters
- Defined in:
- gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb
Overview
When making an API call, you may pass BatchParameters data as a hash:
{
job_definition: "String", # required
job_name: "String", # required
array_properties: {
size: 1,
},
retry_strategy: {
attempts: 1,
},
}
The custom parameters to be used when the target is an Batch job.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#array_properties ⇒ Types::BatchArrayProperties
The array properties for the submitted job, such as the size of the array.
-
#job_definition ⇒ String
The ARN or name of the job definition to use if the event target is an Batch job.
-
#job_name ⇒ String
The name to use for this execution of the job, if the target is an Batch job.
-
#retry_strategy ⇒ Types::BatchRetryStrategy
The retry strategy to use for failed jobs, if the target is an Batch job.
Instance Attribute Details
#array_properties ⇒ Types::BatchArrayProperties
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 Batch job.
249 250 251 252 253 254 255 256 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 249 class BatchParameters < Struct.new( :job_definition, :job_name, :array_properties, :retry_strategy) SENSITIVE = [] include Aws::Structure end |
#job_definition ⇒ String
The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.
249 250 251 252 253 254 255 256 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 249 class BatchParameters < Struct.new( :job_definition, :job_name, :array_properties, :retry_strategy) SENSITIVE = [] include Aws::Structure end |
#job_name ⇒ String
The name to use for this execution of the job, if the target is an Batch job.
249 250 251 252 253 254 255 256 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 249 class BatchParameters < Struct.new( :job_definition, :job_name, :array_properties, :retry_strategy) SENSITIVE = [] include Aws::Structure end |
#retry_strategy ⇒ Types::BatchRetryStrategy
The retry strategy to use for failed jobs, if the target is an 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.
249 250 251 252 253 254 255 256 |
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 249 class BatchParameters < Struct.new( :job_definition, :job_name, :array_properties, :retry_strategy) SENSITIVE = [] include Aws::Structure end |