Struct aws_sdk_batch::types::builders::JobDefinitionBuilder

#[non_exhaustive]
pub struct JobDefinitionBuilder { /* private fields */ }

A builder for JobDefinition.

Implementations

impl JobDefinitionBuilder

pub fn job_definition_name(self, input: impl Into<String>) -> Self

The name of the job definition.

pub fn set_job_definition_name(self, input: Option<String>) -> Self

The name of the job definition.

pub fn get_job_definition_name(&self) -> &Option<String>

The name of the job definition.

pub fn job_definition_arn(self, input: impl Into<String>) -> Self

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

pub fn set_job_definition_arn(self, input: Option<String>) -> Self

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

pub fn get_job_definition_arn(&self) -> &Option<String>

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

pub fn revision(self, input: i32) -> Self

The revision of the job definition.

pub fn set_revision(self, input: Option<i32>) -> Self

The revision of the job definition.

pub fn get_revision(&self) -> &Option<i32>

The revision of the job definition.

pub fn status(self, input: impl Into<String>) -> Self

The status of the job definition.

pub fn set_status(self, input: Option<String>) -> Self

The status of the job definition.

pub fn get_status(&self) -> &Option<String>

The status of the job definition.

pub fn type(self, input: impl Into<String>) -> Self

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 set_type(self, input: Option<String>) -> Self

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 get_type(&self) -> &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.

pub fn scheduling_priority(self, input: i32) -> Self

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 set_scheduling_priority(self, input: Option<i32>) -> Self

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 get_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, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to parameters.

To override the contents of this collection use set_parameters.

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 set_parameters(self, input: Option<HashMap<String, String>>) -> Self

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 get_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, input: RetryStrategy) -> Self

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

pub fn set_retry_strategy(self, input: Option<RetryStrategy>) -> Self

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

pub fn get_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, input: ContainerProperties) -> Self

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 set_container_properties( self, input: Option<ContainerProperties> ) -> Self

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 get_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, input: JobTimeout) -> Self

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 set_timeout(self, input: Option<JobTimeout>) -> Self

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 get_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, input: NodeProperties) -> Self

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 set_node_properties(self, input: Option<NodeProperties>) -> Self

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 get_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, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

The tags that are applied to the job definition.

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

The tags that are applied to the job definition.

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

The tags that are applied to the job definition.

pub fn propagate_tags(self, input: bool) -> Self

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 set_propagate_tags(self, input: Option<bool>) -> Self

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 get_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, input: PlatformCapability) -> Self

Appends an item to platform_capabilities.

To override the contents of this collection use set_platform_capabilities.

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

pub fn set_platform_capabilities( self, input: Option<Vec<PlatformCapability>> ) -> Self

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

pub fn get_platform_capabilities(&self) -> &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.

pub fn eks_properties(self, input: EksProperties) -> Self

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 set_eks_properties(self, input: Option<EksProperties>) -> Self

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 get_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, input: OrchestrationType) -> Self

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

pub fn set_container_orchestration_type( self, input: Option<OrchestrationType> ) -> Self

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

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

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

pub fn build(self) -> JobDefinition

Consumes the builder and constructs a JobDefinition.

Trait Implementations

impl Clone for JobDefinitionBuilder

fn clone(&self) -> JobDefinitionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JobDefinitionBuilder

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

Formats the value using the given formatter.

impl Default for JobDefinitionBuilder

fn default() -> JobDefinitionBuilder

Returns the “default value” for a type.

impl PartialEq<JobDefinitionBuilder> for JobDefinitionBuilder

fn eq(&self, other: &JobDefinitionBuilder) -> 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 JobDefinitionBuilder