File Coverage

blib/lib/Paws/ECS/StartTask.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ECS::StartTask;
3 1     1   321 use Moose;
  1         3  
  1         6  
4             has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' );
5             has ContainerInstances => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'containerInstances' , required => 1);
6             has Group => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'group' );
7             has Overrides => (is => 'ro', isa => 'Paws::ECS::TaskOverride', traits => ['NameInRequest'], request_name => 'overrides' );
8             has StartedBy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'startedBy' );
9             has TaskDefinition => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'taskDefinition' , required => 1);
10              
11 1     1   6369 use MooseX::ClassAttribute;
  1         2  
  1         8  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartTask');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::StartTaskResponse');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::ECS::StartTask - Arguments for method StartTask on Paws::ECS
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method StartTask on the
27             Amazon EC2 Container Service service. Use the attributes of this class
28             as arguments to method StartTask.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartTask.
31              
32             As an example:
33              
34             $service_obj->StartTask(Att1 => $value1, Att2 => $value2, ...);
35              
36             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 Cluster => Str
42              
43             The short name or full Amazon Resource Name (ARN) of the cluster on
44             which to start your task. If you do not specify a cluster, the default
45             cluster is assumed.
46              
47              
48              
49             =head2 B<REQUIRED> ContainerInstances => ArrayRef[Str|Undef]
50              
51             The container instance IDs or full Amazon Resource Name (ARN) entries
52             for the container instances on which you would like to place your task.
53             You can specify up to 10 container instances.
54              
55              
56              
57             =head2 Group => Str
58              
59             The name of the task group to associate with the task. The default
60             value is the family name of the task definition (for example,
61             family:my-family-name).
62              
63              
64              
65             =head2 Overrides => L<Paws::ECS::TaskOverride>
66              
67             A list of container overrides in JSON format that specify the name of a
68             container in the specified task definition and the overrides it should
69             receive. You can override the default command for a container (that is
70             specified in the task definition or Docker image) with a C<command>
71             override. You can also override existing environment variables (that
72             are specified in the task definition or Docker image) on a container or
73             add new environment variables to it with an C<environment> override.
74              
75             A total of 8192 characters are allowed for overrides. This limit
76             includes the JSON formatting characters of the override structure.
77              
78              
79              
80             =head2 StartedBy => Str
81              
82             An optional tag specified when a task is started. For example if you
83             automatically trigger a task to run a batch process job, you could
84             apply a unique identifier for that job to your task with the
85             C<startedBy> parameter. You can then identify which tasks belong to
86             that job by filtering the results of a ListTasks call with the
87             C<startedBy> value. Up to 36 letters (uppercase and lowercase),
88             numbers, hyphens, and underscores are allowed.
89              
90             If a task is started by an Amazon ECS service, then the C<startedBy>
91             parameter contains the deployment ID of the service that starts it.
92              
93              
94              
95             =head2 B<REQUIRED> TaskDefinition => Str
96              
97             The C<family> and C<revision> (C<family:revision>) or full Amazon
98             Resource Name (ARN) of the task definition to start. If a C<revision>
99             is not specified, the latest C<ACTIVE> revision is used.
100              
101              
102              
103              
104             =head1 SEE ALSO
105              
106             This class forms part of L<Paws>, documenting arguments for method StartTask in L<Paws::ECS>
107              
108             =head1 BUGS and CONTRIBUTIONS
109              
110             The source code is located here: https://github.com/pplu/aws-sdk-perl
111              
112             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
113              
114             =cut
115