File Coverage

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