Struct aws_sdk_batch::model::JobDefinition

#[non_exhaustive]
pub struct JobDefinition {

    pub job_definition_name: Option<String>,
    pub job_definition_arn: Option<String>,
    pub revision: i32,
    pub status: Option<String>,
    pub type: Option<String>,
    pub scheduling_priority: i32,
    pub parameters: Option<HashMap<String, String>>,
    pub retry_strategy: Option<RetryStrategy>,
    pub container_properties: Option<ContainerProperties>,
    pub timeout: Option<JobTimeout>,
    pub node_properties: Option<NodeProperties>,
    pub tags: Option<HashMap<String, String>>,
    pub propagate_tags: bool,
    pub platform_capabilities: Option<Vec<PlatformCapability>>,
}

An object representing an Batch job definition.

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_name: Option<String>

The name of the job definition.

job_definition_arn: Option<String>

The Amazon Resource Name (ARN) for the job definition.

revision: i32

The revision of the job definition.

status: Option<String>

The status of the job definition.

type: Option<String>

The type of job definition, either container or multinode. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

scheduling_priority: i32

The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

parameters: Option<HashMap<String, String>>

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters in the Batch User Guide.

retry_strategy: Option<RetryStrategy>

The retry strategy to use for failed jobs that are submitted with this job definition.

container_properties: Option<ContainerProperties>

An object with various properties specific to container-based jobs.

timeout: Option<JobTimeout>

The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished.

node_properties: Option<NodeProperties>

An object with various properties specific to multi-node parallel jobs.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

tags: Option<HashMap<String, String>>

The tags applied to the job definition.

propagate_tags: bool

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

platform_capabilities: Option<Vec<PlatformCapability>>

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Implementations

impl JobDefinition

pub fn job_definition_name(&self) -> Option<&str>

The name of the job definition.

pub fn job_definition_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for the job definition.

pub fn revision(&self) -> i32

The revision of the job definition.

pub fn status(&self) -> Option<&str>

The status of the job definition.

pub fn type(&self) -> Option<&str>

The type of job definition, either container or multinode. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

pub fn scheduling_priority(&self) -> i32

The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

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

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job Definition Parameters in the Batch User Guide.

pub fn retry_strategy(&self) -> Option<&RetryStrategy>

The retry strategy to use for failed jobs that are submitted with this job definition.

pub fn container_properties(&self) -> Option<&ContainerProperties>

An object with various properties specific to container-based jobs.

pub fn timeout(&self) -> Option<&JobTimeout>

The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished.

pub fn node_properties(&self) -> Option<&NodeProperties>

An object with various properties specific to multi-node parallel jobs.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

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

The tags applied to the job definition.

pub fn propagate_tags(&self) -> bool

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

pub fn platform_capabilities(&self) -> Option<&[PlatformCapability]>

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

impl JobDefinition

pub fn builder() -> Builder

Creates a new builder-style object to manufacture JobDefinition

Trait Implementations

impl Clone for JobDefinition

fn clone(&self) -> JobDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobDefinition

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

Formats the value using the given formatter.

impl PartialEq<JobDefinition> for JobDefinition

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for JobDefinition