You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EventBridge::Types::BatchParameters

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb

Overview

Note:

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 AWS Batch job.

See Also:

Instance Attribute Summary collapse

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 AWS Batch job.

Returns:



136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 136

class BatchParameters < Struct.new(
  :job_definition,
  :job_name,
  :array_properties,
  :retry_strategy)
  include Aws::Structure
end

#job_definition ⇒ String

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.

Returns:

  • (String) 


136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 136

class BatchParameters < Struct.new(
  :job_definition,
  :job_name,
  :array_properties,
  :retry_strategy)
  include Aws::Structure
end

#job_name ⇒ String

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

Returns:

  • (String) 


136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 136

class BatchParameters < Struct.new(
  :job_definition,
  :job_name,
  :array_properties,
  :retry_strategy)
  include Aws::Structure
end

#retry_strategy ⇒ Types::BatchRetryStrategy

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.

Returns:



136
137
138
139
140
141
142
 
# File 'gems/aws-sdk-eventbridge/lib/aws-sdk-eventbridge/types.rb', line 136

class BatchParameters < Struct.new(
  :job_definition,
  :job_name,
  :array_properties,
  :retry_strategy)
  include Aws::Structure
end