#[non_exhaustive]pub struct RegisterJobDefinitionInput {Show 14 fields
pub job_definition_name: Option<String>,
pub type: Option<JobDefinitionType>,
pub parameters: Option<HashMap<String, String>>,
pub scheduling_priority: Option<i32>,
pub container_properties: Option<ContainerProperties>,
pub node_properties: Option<NodeProperties>,
pub retry_strategy: Option<RetryStrategy>,
pub propagate_tags: Option<bool>,
pub timeout: Option<JobTimeout>,
pub tags: Option<HashMap<String, String>>,
pub platform_capabilities: Option<Vec<PlatformCapability>>,
pub eks_properties: Option<EksProperties>,
pub ecs_properties: Option<EcsProperties>,
pub consumable_resource_properties: Option<ConsumableResourceProperties>,
}Expand description
Contains the parameters for RegisterJobDefinition.
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 to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
type: Option<JobDefinitionType>The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
-
If the value is
container, then one of the following is required:containerProperties,ecsProperties, oreksProperties. -
If the value is
multinode, thennodePropertiesis required.
If the job is run on Fargate resources, then multinode isn't supported.
parameters: Option<HashMap<String, String>>Default parameter substitution placeholders to 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.
scheduling_priority: Option<i32>The scheduling priority for jobs that are submitted with this 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.
The minimum supported value is 0 and the maximum supported value is 9999.
container_properties: Option<ContainerProperties>An object with properties specific to Amazon ECS-based single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties. This must not be specified for Amazon EKS-based job definitions.
If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.
node_properties: Option<NodeProperties>An object with properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the Batch User Guide.
If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
If the job runs on Amazon EKS resources, then you must not specify nodeProperties.
retry_strategy: Option<RetryStrategy>The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
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 are not 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.
If the job runs on Amazon EKS resources, then you must not specify propagateTags.
timeout: Option<JobTimeout>The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.
The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.
platform_capabilities: Option<Vec<PlatformCapability>>The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.
If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.
eks_properties: Option<EksProperties>An object with properties that are specific to Amazon EKS-based jobs. This must not be specified for Amazon ECS based job definitions.
ecs_properties: Option<EcsProperties>An object with properties that are specific to Amazon ECS-based jobs. This must not be specified for Amazon EKS-based job definitions.
consumable_resource_properties: Option<ConsumableResourceProperties>Contains a list of consumable resources required by the job.
Implementations§
Source§impl RegisterJobDefinitionInput
impl RegisterJobDefinitionInput
Sourcepub fn job_definition_name(&self) -> Option<&str>
pub fn job_definition_name(&self) -> Option<&str>
The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Sourcepub fn type(&self) -> Option<&JobDefinitionType>
pub fn type(&self) -> Option<&JobDefinitionType>
The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
-
If the value is
container, then one of the following is required:containerProperties,ecsProperties, oreksProperties. -
If the value is
multinode, thennodePropertiesis required.
If the job is run on Fargate resources, then multinode isn't supported.
Sourcepub fn parameters(&self) -> Option<&HashMap<String, String>>
pub fn parameters(&self) -> Option<&HashMap<String, String>>
Default parameter substitution placeholders to 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.
Sourcepub fn scheduling_priority(&self) -> Option<i32>
pub fn scheduling_priority(&self) -> Option<i32>
The scheduling priority for jobs that are submitted with this 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.
The minimum supported value is 0 and the maximum supported value is 9999.
Sourcepub fn container_properties(&self) -> Option<&ContainerProperties>
pub fn container_properties(&self) -> Option<&ContainerProperties>
An object with properties specific to Amazon ECS-based single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties. This must not be specified for Amazon EKS-based job definitions.
If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.
Sourcepub fn node_properties(&self) -> Option<&NodeProperties>
pub fn node_properties(&self) -> Option<&NodeProperties>
An object with properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the Batch User Guide.
If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.
If the job runs on Amazon EKS resources, then you must not specify nodeProperties.
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. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
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 are not 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.
If the job runs on Amazon EKS resources, then you must not specify propagateTags.
Sourcepub fn timeout(&self) -> Option<&JobTimeout>
pub fn timeout(&self) -> Option<&JobTimeout>
The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.
The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.
Sourcepub fn platform_capabilities(&self) -> &[PlatformCapability]
pub fn platform_capabilities(&self) -> &[PlatformCapability]
The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.
If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.
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().
Sourcepub fn eks_properties(&self) -> Option<&EksProperties>
pub fn eks_properties(&self) -> Option<&EksProperties>
An object with properties that are specific to Amazon EKS-based jobs. This must not be specified for Amazon ECS based job definitions.
Sourcepub fn ecs_properties(&self) -> Option<&EcsProperties>
pub fn ecs_properties(&self) -> Option<&EcsProperties>
An object with properties that are specific to Amazon ECS-based jobs. This must not be specified for Amazon EKS-based job definitions.
Sourcepub fn consumable_resource_properties(
&self,
) -> Option<&ConsumableResourceProperties>
pub fn consumable_resource_properties( &self, ) -> Option<&ConsumableResourceProperties>
Contains a list of consumable resources required by the job.
Source§impl RegisterJobDefinitionInput
impl RegisterJobDefinitionInput
Sourcepub fn builder() -> RegisterJobDefinitionInputBuilder
pub fn builder() -> RegisterJobDefinitionInputBuilder
Creates a new builder-style object to manufacture RegisterJobDefinitionInput.
Trait Implementations§
Source§impl Clone for RegisterJobDefinitionInput
impl Clone for RegisterJobDefinitionInput
Source§fn clone(&self) -> RegisterJobDefinitionInput
fn clone(&self) -> RegisterJobDefinitionInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for RegisterJobDefinitionInput
impl Debug for RegisterJobDefinitionInput
impl StructuralPartialEq for RegisterJobDefinitionInput
Auto Trait Implementations§
impl Freeze for RegisterJobDefinitionInput
impl RefUnwindSafe for RegisterJobDefinitionInput
impl Send for RegisterJobDefinitionInput
impl Sync for RegisterJobDefinitionInput
impl Unpin for RegisterJobDefinitionInput
impl UnwindSafe for RegisterJobDefinitionInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);