| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Batch::ContainerOverrides; | ||
| 3 | use Moose; | ||
| 4 | has Command => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'command', traits => ['NameInRequest']); | ||
| 5 | has Environment => (is => 'ro', isa => 'ArrayRef[Paws::Batch::KeyValuePair]', request_name => 'environment', traits => ['NameInRequest']); | ||
| 6 | has InstanceType => (is => 'ro', isa => 'Str', request_name => 'instanceType', traits => ['NameInRequest']); | ||
| 7 | has Memory => (is => 'ro', isa => 'Int', request_name => 'memory', traits => ['NameInRequest']); | ||
| 8 | has ResourceRequirements => (is => 'ro', isa => 'ArrayRef[Paws::Batch::ResourceRequirement]', request_name => 'resourceRequirements', traits => ['NameInRequest']); | ||
| 9 | has Vcpus => (is => 'ro', isa => 'Int', request_name => 'vcpus', traits => ['NameInRequest']); | ||
| 10 | |||
| 11 | 1; | ||
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::Batch::ContainerOverrides | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::Batch::ContainerOverrides object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { Command => $value, ..., Vcpus => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::Batch::ContainerOverrides object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->Command | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | The overrides that should be sent to a container. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 Command => ArrayRef[Str|Undef] | ||
| 47 | |||
| 48 | The command to send to the container that overrides the default command | ||
| 49 | from the Docker image or the job definition. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Environment => ArrayRef[L<Paws::Batch::KeyValuePair>] | ||
| 53 | |||
| 54 | The environment variables to send to the container. You can add new | ||
| 55 | environment variables, which are added to the container at launch, or | ||
| 56 | you can override the existing environment variables from the Docker | ||
| 57 | image or the job definition. | ||
| 58 | |||
| 59 | Environment variables must not start with C<AWS_BATCH>; this naming | ||
| 60 | convention is reserved for variables that are set by the AWS Batch | ||
| 61 | service. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 InstanceType => Str | ||
| 65 | |||
| 66 | The instance type to use for a multi-node parallel job. | ||
| 67 | |||
| 68 | This parameter isn't applicable to single-node container jobs or for | ||
| 69 | jobs running on Fargate resources and shouldn't be provided. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 Memory => Int | ||
| 73 | |||
| 74 | This parameter indicates the amount of memory (in MiB) that's reserved | ||
| 75 | for the job. It overrides the C<memory> parameter set in the job | ||
| 76 | definition, but doesn't override any memory requirement specified in | ||
| 77 | the C<ResourceRequirement> structure in the job definition. | ||
| 78 | |||
| 79 | This parameter is supported for jobs that run on EC2 resources, but | ||
| 80 | isn't supported for jobs that run on Fargate resources. For these | ||
| 81 | resources, use C<resourceRequirement> instead. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 ResourceRequirements => ArrayRef[L<Paws::Batch::ResourceRequirement>] | ||
| 85 | |||
| 86 | The type and amount of resources to assign to a container. This | ||
| 87 | overrides the settings in the job definition. The supported resources | ||
| 88 | include C<GPU>, C<MEMORY>, and C<VCPU>. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 Vcpus => Int | ||
| 92 | |||
| 93 | This parameter indicates the number of vCPUs reserved for the | ||
| 94 | container.It overrides the C<vcpus> parameter that's set in the job | ||
| 95 | definition, but doesn't override any vCPU requirement specified in the | ||
| 96 | C<resourceRequirement> structure in the job definition. | ||
| 97 | |||
| 98 | This parameter is supported for jobs that run on EC2 resources, but | ||
| 99 | isn't supported for jobs that run on Fargate resources. For Fargate | ||
| 100 | resources, you can only use C<resourceRequirement>. For EC2 resources, | ||
| 101 | you can use either this parameter or C<resourceRequirement> but not | ||
| 102 | both. | ||
| 103 | |||
| 104 | This parameter maps to C<CpuShares> in the Create a container | ||
| 105 | (https://docs.docker.com/engine/api/v1.23/#create-a-container) section | ||
| 106 | of the Docker Remote API (https://docs.docker.com/engine/api/v1.23/) | ||
| 107 | and the C<--cpu-shares> option to docker run | ||
| 108 | (https://docs.docker.com/engine/reference/run/). Each vCPU is | ||
| 109 | equivalent to 1,024 CPU shares. You must specify at least one vCPU. | ||
| 110 | |||
| 111 | This parameter isn't applicable to jobs that run on Fargate resources | ||
| 112 | and shouldn't be provided. For jobs that run on Fargate resources, you | ||
| 113 | must specify the vCPU requirement for the job using | ||
| 114 | C<resourceRequirements>. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, describing an object used in L<Paws::Batch> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |