Struct BatchParameters

#[non_exhaustive]
pub struct BatchParameters {
    pub job_definition: String,
    pub job_name: String,
    pub array_properties: Option<BatchArrayProperties>,
    pub retry_strategy: Option<BatchRetryStrategy>,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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.

job_name: String

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

array_properties: Option<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.

retry_strategy: Option<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.

Implementations

impl BatchParameters

pub fn job_definition(&self) -> &str

The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.

pub fn job_name(&self) -> &str

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

pub fn array_properties(&self) -> Option<&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.

pub fn retry_strategy(&self) -> Option<&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.

impl BatchParameters

pub fn builder() -> BatchParametersBuilder

Creates a new builder-style object to manufacture BatchParameters.

Trait Implementations

impl Clone for BatchParameters

fn clone(&self) -> BatchParameters

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BatchParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for BatchParameters

fn eq(&self, other: &BatchParameters) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BatchParameters