Struct aws_sdk_batch::model::JobDefinition
source · [−]#[non_exhaustive]pub struct JobDefinition {Show 14 fields
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>>,
}
Expand description
An object representing an Batch job definition.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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.
The tags applied to the job definition.
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
sourceimpl JobDefinition
impl JobDefinition
sourcepub fn job_definition_name(&self) -> Option<&str>
pub fn job_definition_name(&self) -> Option<&str>
The name of the job definition.
sourcepub fn job_definition_arn(&self) -> Option<&str>
pub fn job_definition_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the job definition.
sourcepub fn type(&self) -> Option<&str>
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.
sourcepub fn scheduling_priority(&self) -> i32
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.
sourcepub fn parameters(&self) -> Option<&HashMap<String, String>>
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.
sourcepub fn retry_strategy(&self) -> Option<&RetryStrategy>
pub fn retry_strategy(&self) -> Option<&RetryStrategy>
The retry strategy to use for failed jobs that are submitted with this job definition.
sourcepub fn container_properties(&self) -> Option<&ContainerProperties>
pub fn container_properties(&self) -> Option<&ContainerProperties>
An object with various properties specific to container-based jobs.
sourcepub fn timeout(&self) -> Option<&JobTimeout>
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.
sourcepub fn node_properties(&self) -> Option<&NodeProperties>
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.
The tags applied to the job definition.
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.
sourcepub fn platform_capabilities(&self) -> Option<&[PlatformCapability]>
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
.
sourceimpl JobDefinition
impl JobDefinition
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture JobDefinition
Trait Implementations
sourceimpl Clone for JobDefinition
impl Clone for JobDefinition
sourcefn clone(&self) -> JobDefinition
fn clone(&self) -> JobDefinition
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for JobDefinition
impl Debug for JobDefinition
sourceimpl PartialEq<JobDefinition> for JobDefinition
impl PartialEq<JobDefinition> for JobDefinition
sourcefn eq(&self, other: &JobDefinition) -> bool
fn eq(&self, other: &JobDefinition) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &JobDefinition) -> bool
fn ne(&self, other: &JobDefinition) -> bool
This method tests for !=
.
impl StructuralPartialEq for JobDefinition
Auto Trait Implementations
impl RefUnwindSafe for JobDefinition
impl Send for JobDefinition
impl Sync for JobDefinition
impl Unpin for JobDefinition
impl UnwindSafe for JobDefinition
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more