Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Batch.Types.JobDefinition

Description

Synopsis

data JobDefinition = JobDefinition' {
- containerOrchestrationType :: Maybe OrchestrationType
- containerProperties :: Maybe ContainerProperties
- eksProperties :: Maybe EksProperties
- nodeProperties :: Maybe NodeProperties
- parameters :: Maybe (HashMap Text Text)
- platformCapabilities :: Maybe [PlatformCapability]
- propagateTags :: Maybe Bool
- retryStrategy :: Maybe RetryStrategy
- schedulingPriority :: Maybe Int
- status :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- timeout :: Maybe JobTimeout
- jobDefinitionName :: Text
- jobDefinitionArn :: Text
- revision :: Int
- type' :: Text
}
newJobDefinition :: Text -> Text -> Int -> Text -> JobDefinition
jobDefinition_containerOrchestrationType :: Lens' JobDefinition (Maybe OrchestrationType)
jobDefinition_containerProperties :: Lens' JobDefinition (Maybe ContainerProperties)
jobDefinition_eksProperties :: Lens' JobDefinition (Maybe EksProperties)
jobDefinition_nodeProperties :: Lens' JobDefinition (Maybe NodeProperties)
jobDefinition_parameters :: Lens' JobDefinition (Maybe (HashMap Text Text))
jobDefinition_platformCapabilities :: Lens' JobDefinition (Maybe [PlatformCapability])
jobDefinition_propagateTags :: Lens' JobDefinition (Maybe Bool)
jobDefinition_retryStrategy :: Lens' JobDefinition (Maybe RetryStrategy)
jobDefinition_schedulingPriority :: Lens' JobDefinition (Maybe Int)
jobDefinition_status :: Lens' JobDefinition (Maybe Text)
jobDefinition_tags :: Lens' JobDefinition (Maybe (HashMap Text Text))
jobDefinition_timeout :: Lens' JobDefinition (Maybe JobTimeout)
jobDefinition_jobDefinitionName :: Lens' JobDefinition Text
jobDefinition_jobDefinitionArn :: Lens' JobDefinition Text
jobDefinition_revision :: Lens' JobDefinition Int
jobDefinition_type :: Lens' JobDefinition Text

Documentation

data JobDefinition Source #

An object that represents an Batch job definition.

See: newJobDefinition smart constructor.

Constructors

JobDefinition'

Fields

containerOrchestrationType :: Maybe OrchestrationType
The orchestration type of the compute environment. The valid values are ECS (default) or EKS.
containerProperties :: Maybe ContainerProperties
An object with various properties specific to Amazon ECS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.
eksProperties :: Maybe 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.
nodeProperties :: Maybe 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.
parameters :: Maybe (HashMap Text Text)
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.
platformCapabilities :: Maybe [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.
propagateTags :: Maybe 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.
retryStrategy :: Maybe RetryStrategy
The retry strategy to use for failed jobs that are submitted with this job definition.
schedulingPriority :: Maybe Int
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.
status :: Maybe Text
The status of the job definition.
tags :: Maybe (HashMap Text Text)
The tags that are applied to the job definition.
timeout :: Maybe 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.
jobDefinitionName :: Text
The name of the job definition.
jobDefinitionArn :: Text
The Amazon Resource Name (ARN) for the job definition.
revision :: Int
The revision of the job definition.
type' :: Text
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.

Instances

Instances details

FromJSON JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition Methods parseJSON :: Value -> Parser JobDefinition # parseJSONList :: Value -> Parser [JobDefinition] #
Generic JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition Associated Types type Rep JobDefinition :: Type -> Type # Methods from :: JobDefinition -> Rep JobDefinition x # to :: Rep JobDefinition x -> JobDefinition #
Read JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition Methods readsPrec :: Int -> ReadS JobDefinition # readList :: ReadS [JobDefinition] # readPrec :: ReadPrec JobDefinition # readListPrec :: ReadPrec [JobDefinition] #
Show JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition Methods showsPrec :: Int -> JobDefinition -> ShowS # show :: JobDefinition -> String # showList :: [JobDefinition] -> ShowS #
NFData JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition Methods rnf :: JobDefinition -> () #
Eq JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition Methods (==) :: JobDefinition -> JobDefinition -> Bool # (/=) :: JobDefinition -> JobDefinition -> Bool #
Hashable JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition Methods hashWithSalt :: Int -> JobDefinition -> Int # hash :: JobDefinition -> Int #
type Rep JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition type Rep JobDefinition = D1 ('MetaData "JobDefinition" "Amazonka.Batch.Types.JobDefinition" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "JobDefinition'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "containerOrchestrationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrchestrationType)) :: S1 ('MetaSel ('Just "containerProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerProperties))) :: (S1 ('MetaSel ('Just "eksProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksProperties)) :: S1 ('MetaSel ('Just "nodeProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeProperties)))) :: ((S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "platformCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlatformCapability]))) :: (S1 ('MetaSel ('Just "propagateTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "retryStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetryStrategy))))) :: (((S1 ('MetaSel ('Just "schedulingPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobTimeout)))) :: ((S1 ('MetaSel ('Just "jobDefinitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "jobDefinitionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newJobDefinition Source #

Arguments

:: Text	`$sel:jobDefinitionName:JobDefinition'`
-> Text	`$sel:jobDefinitionArn:JobDefinition'`
-> Int	`$sel:revision:JobDefinition'`
-> Text	`$sel:type':JobDefinition'`
-> JobDefinition

Create a value of JobDefinition with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerOrchestrationType:JobDefinition', jobDefinition_containerOrchestrationType - The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

$sel:containerProperties:JobDefinition', jobDefinition_containerProperties - An object with various properties specific to Amazon ECS based jobs. Valid values are containerProperties, eksProperties, and nodeProperties. Only one can be specified.

$sel:eksProperties:JobDefinition', jobDefinition_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.

$sel:nodeProperties:JobDefinition', jobDefinition_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.

$sel:parameters:JobDefinition', jobDefinition_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.

$sel:platformCapabilities:JobDefinition', jobDefinition_platformCapabilities - The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

$sel:propagateTags:JobDefinition', jobDefinition_propagateTags - 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.

$sel:retryStrategy:JobDefinition', jobDefinition_retryStrategy - The retry strategy to use for failed jobs that are submitted with this job definition.

$sel:schedulingPriority:JobDefinition', jobDefinition_schedulingPriority - 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.

$sel:status:JobDefinition', jobDefinition_status - The status of the job definition.

$sel:tags:JobDefinition', jobDefinition_tags - The tags that are applied to the job definition.

$sel:timeout:JobDefinition', jobDefinition_timeout - 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.

$sel:jobDefinitionName:JobDefinition', jobDefinition_jobDefinitionName - The name of the job definition.

$sel:jobDefinitionArn:JobDefinition', jobDefinition_jobDefinitionArn - The Amazon Resource Name (ARN) for the job definition.

$sel:revision:JobDefinition', jobDefinition_revision - The revision of the job definition.

$sel:type':JobDefinition', jobDefinition_type - 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.

jobDefinition_containerOrchestrationType :: Lens' JobDefinition (Maybe OrchestrationType) Source #

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

jobDefinition_containerProperties :: Lens' JobDefinition (Maybe ContainerProperties) Source #

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

jobDefinition_eksProperties :: Lens' JobDefinition (Maybe EksProperties) Source #

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.

jobDefinition_nodeProperties :: Lens' JobDefinition (Maybe NodeProperties) Source #

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.

jobDefinition_parameters :: Lens' JobDefinition (Maybe (HashMap Text Text)) Source #

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.

jobDefinition_platformCapabilities :: Lens' JobDefinition (Maybe [PlatformCapability]) Source #

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

jobDefinition_propagateTags :: Lens' JobDefinition (Maybe Bool) Source #

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.

jobDefinition_retryStrategy :: Lens' JobDefinition (Maybe RetryStrategy) Source #

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

jobDefinition_schedulingPriority :: Lens' JobDefinition (Maybe Int) Source #

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.

jobDefinition_status :: Lens' JobDefinition (Maybe Text) Source #

The status of the job definition.

jobDefinition_tags :: Lens' JobDefinition (Maybe (HashMap Text Text)) Source #

The tags that are applied to the job definition.

jobDefinition_timeout :: Lens' JobDefinition (Maybe JobTimeout) Source #

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.

jobDefinition_jobDefinitionName :: Lens' JobDefinition Text Source #

The name of the job definition.

jobDefinition_jobDefinitionArn :: Lens' JobDefinition Text Source #

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

jobDefinition_revision :: Lens' JobDefinition Int Source #

The revision of the job definition.

jobDefinition_type :: Lens' JobDefinition Text Source #

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.