Struct aws_sdk_batch::types::JobDefinition

#[non_exhaustive]
pub struct JobDefinition {

    pub job_definition_name: Option<String>,
    pub job_definition_arn: Option<String>,
    pub revision: Option<i32>,
    pub status: Option<String>,
    pub type: Option<String>,
    pub scheduling_priority: Option<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: Option<bool>,
    pub platform_capabilities: Option<Vec<PlatformCapability>>,
    pub eks_properties: Option<EksProperties>,
    pub container_orchestration_type: Option<OrchestrationType>,
}

An object that represents 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: Option<i32>

The revision of the job definition.

status: Option<String>

The status of the job definition.

type: Option<String>

The type of job definition. It's 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: Option<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 Amazon ECS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

timeout: Option<JobTimeout>

The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.

node_properties: Option<NodeProperties>

An object with various properties that are specific to multi-node parallel jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.

tags: Option<HashMap<String, String>>

The tags that are applied to the job definition.

propagate_tags: Option<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 when the tasks are created. 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.

eks_properties: Option<EksProperties>

An object with various properties that are specific to Amazon EKS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

container_orchestration_type: Option<OrchestrationType>

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

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) -> Option<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. It's 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) -> Option<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 Amazon ECS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

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

The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.

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

An object with various properties that are specific to multi-node parallel jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.

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

The tags that are applied to the job definition.

pub fn propagate_tags(&self) -> Option<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 when the tasks are created. 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) -> &[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.

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

pub fn eks_properties(&self) -> Option<&EksProperties>

An object with various properties that are specific to Amazon EKS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

pub fn container_orchestration_type(&self) -> Option<&OrchestrationType>

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

impl JobDefinition

pub fn builder() -> JobDefinitionBuilder

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 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: &Rhs) -> bool

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

impl StructuralPartialEq for JobDefinition