blib/lib/Paws/ECS/Cluster.pm untested

filter: Statementstmt 0.0% 0 / 33 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 34 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::ECS::Cluster;
3 use Moose;
4 has ActiveServicesCount => (is => 'ro', isa => 'Int', request_name => 'activeServicesCount', traits => ['NameInRequest']);
5 has Attachments => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Attachment]', request_name => 'attachments', traits => ['NameInRequest']);
6 has AttachmentsStatus => (is => 'ro', isa => 'Str', request_name => 'attachmentsStatus', traits => ['NameInRequest']);
7 has CapacityProviders => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'capacityProviders', traits => ['NameInRequest']);
8 has ClusterArn => (is => 'ro', isa => 'Str', request_name => 'clusterArn', traits => ['NameInRequest']);
9 has ClusterName => (is => 'ro', isa => 'Str', request_name => 'clusterName', traits => ['NameInRequest']);
10 has Configuration => (is => 'ro', isa => 'Paws::ECS::ClusterConfiguration', request_name => 'configuration', traits => ['NameInRequest']);
11 has DefaultCapacityProviderStrategy => (is => 'ro', isa => 'ArrayRef[Paws::ECS::CapacityProviderStrategyItem]', request_name => 'defaultCapacityProviderStrategy', traits => ['NameInRequest']);
12 has PendingTasksCount => (is => 'ro', isa => 'Int', request_name => 'pendingTasksCount', traits => ['NameInRequest']);
13 has RegisteredContainerInstancesCount => (is => 'ro', isa => 'Int', request_name => 'registeredContainerInstancesCount', traits => ['NameInRequest']);
14 has RunningTasksCount => (is => 'ro', isa => 'Int', request_name => 'runningTasksCount', traits => ['NameInRequest']);
15 has Settings => (is => 'ro', isa => 'ArrayRef[Paws::ECS::ClusterSetting]', request_name => 'settings', traits => ['NameInRequest']);
16 has Statistics => (is => 'ro', isa => 'ArrayRef[Paws::ECS::KeyValuePair]', request_name => 'statistics', traits => ['NameInRequest']);
17 has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']);
18 has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Tag]', request_name => 'tags', traits => ['NameInRequest']);
19  
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::ECS::Cluster
27  
28 =head1 USAGE
29  
30 This class represents one of two things:
31  
32 =head3 Arguments in a call to a service
33  
34 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
35 Each attribute should be used as a named argument in the calls that expect this type of object.
36  
37 As an example, if Att1 is expected to be a Paws::ECS::Cluster object:
38  
39 $service_obj->Method(Att1 => { ActiveServicesCount => $value, ..., Tags => $value });
40  
41 =head3 Results returned from an API call
42  
43 Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::Cluster object:
44  
45 $result = $service_obj->Method(...);
46 $result->Att1->ActiveServicesCount
47  
48 =head1 DESCRIPTION
49  
50 A regional grouping of one or more container instances on which you can
51 run task requests. Each account receives a default cluster the first
52 time you use the Amazon ECS service, but you may also create other
53 clusters. Clusters may contain more than one instance type
54 simultaneously.
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 ActiveServicesCount => Int
60  
61 The number of services that are running on the cluster in an C<ACTIVE>
62 state. You can view these services with ListServices.
63  
64  
65 =head2 Attachments => ArrayRef[L<Paws::ECS::Attachment>]
66  
67 The resources attached to a cluster. When using a capacity provider
68 with a cluster, the Auto Scaling plan that is created will be returned
69 as a cluster attachment.
70  
71  
72 =head2 AttachmentsStatus => Str
73  
74 The status of the capacity providers associated with the cluster. The
75 following are the states that will be returned:
76  
77 =over
78  
79 =item UPDATE_IN_PROGRESS
80  
81 The available capacity providers for the cluster are updating. This
82 occurs when the Auto Scaling plan is provisioning or deprovisioning.
83  
84 =item UPDATE_COMPLETE
85  
86 The capacity providers have successfully updated.
87  
88 =item UPDATE_FAILED
89  
90 The capacity provider updates failed.
91  
92 =back
93  
94  
95  
96 =head2 CapacityProviders => ArrayRef[Str|Undef]
97  
98 The capacity providers associated with the cluster.
99  
100  
101 =head2 ClusterArn => Str
102  
103 The Amazon Resource Name (ARN) that identifies the cluster. The ARN
104 contains the C<arn:aws:ecs> namespace, followed by the Region of the
105 cluster, the AWS account ID of the cluster owner, the C<cluster>
106 namespace, and then the cluster name. For example,
107 C<arn:aws:ecs:region:012345678910:cluster/test>.
108  
109  
110 =head2 ClusterName => Str
111  
112 A user-generated string that you use to identify your cluster.
113  
114  
115 =head2 Configuration => L<Paws::ECS::ClusterConfiguration>
116  
117 The execute command configuration for the cluster.
118  
119  
120 =head2 DefaultCapacityProviderStrategy => ArrayRef[L<Paws::ECS::CapacityProviderStrategyItem>]
121  
122 The default capacity provider strategy for the cluster. When services
123 or tasks are run in the cluster with no launch type or capacity
124 provider strategy specified, the default capacity provider strategy is
125 used.
126  
127  
128 =head2 PendingTasksCount => Int
129  
130 The number of tasks in the cluster that are in the C<PENDING> state.
131  
132  
133 =head2 RegisteredContainerInstancesCount => Int
134  
135 The number of container instances registered into the cluster. This
136 includes container instances in both C<ACTIVE> and C<DRAINING> status.
137  
138  
139 =head2 RunningTasksCount => Int
140  
141 The number of tasks in the cluster that are in the C<RUNNING> state.
142  
143  
144 =head2 Settings => ArrayRef[L<Paws::ECS::ClusterSetting>]
145  
146 The settings for the cluster. This parameter indicates whether
147 CloudWatch Container Insights is enabled or disabled for a cluster.
148  
149  
150 =head2 Statistics => ArrayRef[L<Paws::ECS::KeyValuePair>]
151  
152 Additional information about your clusters that are separated by launch
153 type, including:
154  
155 =over
156  
157 =item *
158  
159 runningEC2TasksCount
160  
161 =item *
162  
163 RunningFargateTasksCount
164  
165 =item *
166  
167 pendingEC2TasksCount
168  
169 =item *
170  
171 pendingFargateTasksCount
172  
173 =item *
174  
175 activeEC2ServiceCount
176  
177 =item *
178  
179 activeFargateServiceCount
180  
181 =item *
182  
183 drainingEC2ServiceCount
184  
185 =item *
186  
187 drainingFargateServiceCount
188  
189 =back
190  
191  
192  
193 =head2 Status => Str
194  
195 The status of the cluster. The following are the possible states that
196 will be returned.
197  
198 =over
199  
200 =item ACTIVE
201  
202 The cluster is ready to accept tasks and if applicable you can register
203 container instances with the cluster.
204  
205 =item PROVISIONING
206  
207 The cluster has capacity providers associated with it and the resources
208 needed for the capacity provider are being created.
209  
210 =item DEPROVISIONING
211  
212 The cluster has capacity providers associated with it and the resources
213 needed for the capacity provider are being deleted.
214  
215 =item FAILED
216  
217 The cluster has capacity providers associated with it and the resources
218 needed for the capacity provider have failed to create.
219  
220 =item INACTIVE
221  
222 The cluster has been deleted. Clusters with an C<INACTIVE> status may
223 remain discoverable in your account for a period of time. However, this
224 behavior is subject to change in the future, so you should not rely on
225 C<INACTIVE> clusters persisting.
226  
227 =back
228  
229  
230  
231 =head2 Tags => ArrayRef[L<Paws::ECS::Tag>]
232  
233 The metadata that you apply to the cluster to help you categorize and
234 organize them. Each tag consists of a key and an optional value, both
235 of which you define.
236  
237 The following basic restrictions apply to tags:
238  
239 =over
240  
241 =item *
242  
243 Maximum number of tags per resource - 50
244  
245 =item *
246  
247 For each resource, each tag key must be unique, and each tag key can
248 have only one value.
249  
250 =item *
251  
252 Maximum key length - 128 Unicode characters in UTF-8
253  
254 =item *
255  
256 Maximum value length - 256 Unicode characters in UTF-8
257  
258 =item *
259  
260 If your tagging schema is used across multiple services and resources,
261 remember that other services may have restrictions on allowed
262 characters. Generally allowed characters are: letters, numbers, and
263 spaces representable in UTF-8, and the following characters: + - = . _
264 : / @.
265  
266 =item *
267  
268 Tag keys and values are case-sensitive.
269  
270 =item *
271  
272 Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of
273 such as a prefix for either keys or values as it is reserved for AWS
274 use. You cannot edit or delete tag keys or values with this prefix.
275 Tags with this prefix do not count against your tags per resource
276 limit.
277  
278 =back
279  
280  
281  
282  
283 =head1 SEE ALSO
284  
285 This class forms part of L<Paws>, describing an object used in L<Paws::ECS>
286  
287 =head1 BUGS and CONTRIBUTIONS
288  
289 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
290  
291 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
292  
293 =cut
294