Struct PipeTargetBatchJobParameters

#[non_exhaustive]
pub struct PipeTargetBatchJobParameters {
    pub job_definition: String,
    pub job_name: String,
    pub array_properties: Option<BatchArrayProperties>,
    pub retry_strategy: Option<BatchRetryStrategy>,
    pub container_overrides: Option<BatchContainerOverrides>,
    pub depends_on: Option<Vec<BatchJobDependency>>,
    pub parameters: Option<HashMap<String, String>>,
}

The parameters for using an Batch job as a target.

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 job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

job_name: String

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

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. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

container_overrides: Option<BatchContainerOverrides>

The overrides that are sent to a container.

depends_on: Option<Vec<BatchJobDependency>>

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

parameters: Option<HashMap<String, String>>

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.

Implementations

impl PipeTargetBatchJobParameters

pub fn job_definition(&self) -> &str

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

pub fn job_name(&self) -> &str

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

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. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

pub fn container_overrides(&self) -> Option<&BatchContainerOverrides>

The overrides that are sent to a container.

pub fn depends_on(&self) -> &[BatchJobDependency]

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .depends_on.is_none().

pub fn parameters(&self) -> Option<&HashMap<String, String>>

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters included here override any corresponding parameter defaults from the job definition.

impl PipeTargetBatchJobParameters

pub fn builder() -> PipeTargetBatchJobParametersBuilder

Creates a new builder-style object to manufacture PipeTargetBatchJobParameters.

Trait Implementations

impl Clone for PipeTargetBatchJobParameters

fn clone(&self) -> PipeTargetBatchJobParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PipeTargetBatchJobParameters

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

Formats the value using the given formatter.

impl PartialEq for PipeTargetBatchJobParameters

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

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

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 PipeTargetBatchJobParameters