| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Batch::JobDefinition; | ||
| 3 | use Moose; | ||
| 4 | has ContainerProperties => (is => 'ro', isa => 'Paws::Batch::ContainerProperties', request_name => 'containerProperties', traits => ['NameInRequest']); | ||
| 5 | has JobDefinitionArn => (is => 'ro', isa => 'Str', request_name => 'jobDefinitionArn', traits => ['NameInRequest'], required => 1); | ||
| 6 | has JobDefinitionName => (is => 'ro', isa => 'Str', request_name => 'jobDefinitionName', traits => ['NameInRequest'], required => 1); | ||
| 7 | has NodeProperties => (is => 'ro', isa => 'Paws::Batch::NodeProperties', request_name => 'nodeProperties', traits => ['NameInRequest']); | ||
| 8 | has Parameters => (is => 'ro', isa => 'Paws::Batch::ParametersMap', request_name => 'parameters', traits => ['NameInRequest']); | ||
| 9 | has PlatformCapabilities => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'platformCapabilities', traits => ['NameInRequest']); | ||
| 10 | has PropagateTags => (is => 'ro', isa => 'Bool', request_name => 'propagateTags', traits => ['NameInRequest']); | ||
| 11 | has RetryStrategy => (is => 'ro', isa => 'Paws::Batch::RetryStrategy', request_name => 'retryStrategy', traits => ['NameInRequest']); | ||
| 12 | has Revision => (is => 'ro', isa => 'Int', request_name => 'revision', traits => ['NameInRequest'], required => 1); | ||
| 13 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 14 | has Tags => (is => 'ro', isa => 'Paws::Batch::TagrisTagsMap', request_name => 'tags', traits => ['NameInRequest']); | ||
| 15 | has Timeout => (is => 'ro', isa => 'Paws::Batch::JobTimeout', request_name => 'timeout', traits => ['NameInRequest']); | ||
| 16 | has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::Batch::JobDefinition | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::Batch::JobDefinition object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { ContainerProperties => $value, ..., Type => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::Batch::JobDefinition object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->ContainerProperties | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | An object representing an AWS Batch job definition. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ContainerProperties => L<Paws::Batch::ContainerProperties> | ||
| 54 | |||
| 55 | An object with various properties specific to container-based jobs. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> JobDefinitionArn => Str | ||
| 59 | |||
| 60 | The Amazon Resource Name (ARN) for the job definition. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> JobDefinitionName => Str | ||
| 64 | |||
| 65 | The name of the job definition. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 NodeProperties => L<Paws::Batch::NodeProperties> | ||
| 69 | |||
| 70 | An object with various properties specific to multi-node parallel jobs. | ||
| 71 | |||
| 72 | If the job runs on Fargate resources, then you must not specify | ||
| 73 | C<nodeProperties>; use C<containerProperties> instead. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 Parameters => L<Paws::Batch::ParametersMap> | ||
| 77 | |||
| 78 | Default parameters or parameter substitution placeholders that are set | ||
| 79 | in the job definition. Parameters are specified as a key-value pair | ||
| 80 | mapping. Parameters in a C<SubmitJob> request override any | ||
| 81 | corresponding parameter defaults from the job definition. For more | ||
| 82 | information about specifying parameters, see Job Definition Parameters | ||
| 83 | (https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html) | ||
| 84 | in the I<AWS Batch User Guide>. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 PlatformCapabilities => ArrayRef[Str|Undef] | ||
| 88 | |||
| 89 | The platform capabilities required by the job definition. If no value | ||
| 90 | is specified, it defaults to C<EC2>. Jobs run on Fargate resources | ||
| 91 | specify C<FARGATE>. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 PropagateTags => Bool | ||
| 95 | |||
| 96 | Specifies whether to propagate the tags from the job or job definition | ||
| 97 | to the corresponding Amazon ECS task. If no value is specified, the | ||
| 98 | tags aren't propagated. Tags can only be propagated to the tasks during | ||
| 99 | task creation. For tags with the same name, job tags are given priority | ||
| 100 | over job definitions tags. If the total number of combined tags from | ||
| 101 | the job and job definition is over 50, the job is moved to the | ||
| 102 | C<FAILED> state. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 RetryStrategy => L<Paws::Batch::RetryStrategy> | ||
| 106 | |||
| 107 | The retry strategy to use for failed jobs that are submitted with this | ||
| 108 | job definition. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 B<REQUIRED> Revision => Int | ||
| 112 | |||
| 113 | The revision of the job definition. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 Status => Str | ||
| 117 | |||
| 118 | The status of the job definition. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 Tags => L<Paws::Batch::TagrisTagsMap> | ||
| 122 | |||
| 123 | The tags applied to the job definition. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 Timeout => L<Paws::Batch::JobTimeout> | ||
| 127 | |||
| 128 | The timeout configuration for jobs that are submitted with this job | ||
| 129 | definition. You can specify a timeout duration after which AWS Batch | ||
| 130 | terminates your jobs if they haven't finished. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 B<REQUIRED> Type => Str | ||
| 134 | |||
| 135 | The type of job definition. If the job is run on Fargate resources, | ||
| 136 | then C<multinode> isn't supported. For more information about | ||
| 137 | multi-node parallel jobs, see Creating a multi-node parallel job | ||
| 138 | definition | ||
| 139 | (https://docs.aws.amazon.com/batch/latest/userguide/multi-node-job-def.html) | ||
| 140 | in the I<AWS Batch User Guide>. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | =head1 SEE ALSO | ||
| 145 | |||
| 146 | This class forms part of L<Paws>, describing an object used in L<Paws::Batch> | ||
| 147 | |||
| 148 | =head1 BUGS and CONTRIBUTIONS | ||
| 149 | |||
| 150 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 151 | |||
| 152 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 153 | |||
| 154 | =cut | ||
| 155 |