Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Batch.Types.JobDefinition

Description

Synopsis

data JobDefinition = JobDefinition' {
- status :: Maybe Text
- propagateTags :: Maybe Bool
- retryStrategy :: Maybe RetryStrategy
- platformCapabilities :: Maybe [PlatformCapability]
- parameters :: Maybe (HashMap Text Text)
- timeout :: Maybe JobTimeout
- containerProperties :: Maybe ContainerProperties
- nodeProperties :: Maybe NodeProperties
- tags :: Maybe (HashMap Text Text)
- jobDefinitionName :: Text
- jobDefinitionArn :: Text
- revision :: Int
- type' :: Text
}
newJobDefinition :: Text -> Text -> Int -> Text -> JobDefinition
jobDefinition_status :: Lens' JobDefinition (Maybe Text)
jobDefinition_propagateTags :: Lens' JobDefinition (Maybe Bool)
jobDefinition_retryStrategy :: Lens' JobDefinition (Maybe RetryStrategy)
jobDefinition_platformCapabilities :: Lens' JobDefinition (Maybe [PlatformCapability])
jobDefinition_parameters :: Lens' JobDefinition (Maybe (HashMap Text Text))
jobDefinition_timeout :: Lens' JobDefinition (Maybe JobTimeout)
jobDefinition_containerProperties :: Lens' JobDefinition (Maybe ContainerProperties)
jobDefinition_nodeProperties :: Lens' JobDefinition (Maybe NodeProperties)
jobDefinition_tags :: Lens' JobDefinition (Maybe (HashMap Text Text))
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 representing an Batch job definition.

See: newJobDefinition smart constructor.

Constructors

JobDefinition'

Fields

status :: Maybe Text
The status of the job definition.
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 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.
retryStrategy :: Maybe RetryStrategy
The retry strategy to use for failed jobs that are submitted with this job definition.
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.
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.
timeout :: Maybe 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.
containerProperties :: Maybe ContainerProperties
An object with various properties specific to container-based jobs.
nodeProperties :: Maybe 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.
tags :: Maybe (HashMap Text Text)
The tags applied to the job definition.
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. 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

Eq JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition Methods (==) :: JobDefinition -> JobDefinition -> Bool # (/=) :: JobDefinition -> JobDefinition -> Bool #
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 #
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 #
NFData JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition Methods rnf :: JobDefinition -> () #
Hashable JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition Methods hashWithSalt :: Int -> JobDefinition -> Int # hash :: JobDefinition -> Int #
FromJSON JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition Methods parseJSON :: Value -> Parser JobDefinition # parseJSONList :: Value -> Parser [JobDefinition] #
type Rep JobDefinition Source #
Instance details Defined in Amazonka.Batch.Types.JobDefinition type Rep JobDefinition = D1 ('MetaData "JobDefinition" "Amazonka.Batch.Types.JobDefinition" "libZSservicesZSamazonka-batchZSamazonka-batch" 'False) (C1 ('MetaCons "JobDefinition'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "propagateTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "retryStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetryStrategy)))) :: (S1 ('MetaSel ('Just "platformCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlatformCapability])) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobTimeout))))) :: ((S1 ('MetaSel ('Just "containerProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerProperties)) :: (S1 ('MetaSel ('Just "nodeProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeProperties)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((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:status:JobDefinition', jobDefinition_status - The status of the job definition.

$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 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.

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

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

$sel:containerProperties:JobDefinition', jobDefinition_containerProperties - An object with various properties specific to container-based jobs.

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

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

$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. 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_status :: Lens' JobDefinition (Maybe Text) Source #

The status of the job definition.

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 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.

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

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

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_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_timeout :: Lens' JobDefinition (Maybe JobTimeout) Source #

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.

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

An object with various properties specific to container-based jobs.

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

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.

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

The tags applied to the job definition.

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. 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.