File Coverage

blib/lib/Paws/ECS/Cluster.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::ECS::Cluster;
2 1     1   591 use Moose;
  1         3  
  1         7  
3             has ActiveServicesCount => (is => 'ro', isa => 'Int', request_name => 'activeServicesCount', traits => ['NameInRequest']);
4             has ClusterArn => (is => 'ro', isa => 'Str', request_name => 'clusterArn', traits => ['NameInRequest']);
5             has ClusterName => (is => 'ro', isa => 'Str', request_name => 'clusterName', traits => ['NameInRequest']);
6             has PendingTasksCount => (is => 'ro', isa => 'Int', request_name => 'pendingTasksCount', traits => ['NameInRequest']);
7             has RegisteredContainerInstancesCount => (is => 'ro', isa => 'Int', request_name => 'registeredContainerInstancesCount', traits => ['NameInRequest']);
8             has RunningTasksCount => (is => 'ro', isa => 'Int', request_name => 'runningTasksCount', traits => ['NameInRequest']);
9             has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']);
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::ECS::Cluster
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::ECS::Cluster object:
28              
29             $service_obj->Method(Att1 => { ActiveServicesCount => $value, ..., Status => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::Cluster object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->ActiveServicesCount
37              
38             =head1 DESCRIPTION
39              
40             A regional grouping of one or more container instances on which you can
41             run task requests. Each account receives a default cluster the first
42             time you use the Amazon ECS service, but you may also create other
43             clusters. Clusters may contain more than one instance type
44             simultaneously.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 ActiveServicesCount => Int
50              
51             The number of services that are running on the cluster in an C<ACTIVE>
52             state. You can view these services with ListServices.
53              
54              
55             =head2 ClusterArn => Str
56              
57             The Amazon Resource Name (ARN) that identifies the cluster. The ARN
58             contains the C<arn:aws:ecs> namespace, followed by the region of the
59             cluster, the AWS account ID of the cluster owner, the C<cluster>
60             namespace, and then the cluster name. For example,
61             C<arn:aws:ecs:I<region>:I<012345678910>:cluster/I<test> >..
62              
63              
64             =head2 ClusterName => Str
65              
66             A user-generated string that you use to identify your cluster.
67              
68              
69             =head2 PendingTasksCount => Int
70              
71             The number of tasks in the cluster that are in the C<PENDING> state.
72              
73              
74             =head2 RegisteredContainerInstancesCount => Int
75              
76             The number of container instances registered into the cluster.
77              
78              
79             =head2 RunningTasksCount => Int
80              
81             The number of tasks in the cluster that are in the C<RUNNING> state.
82              
83              
84             =head2 Status => Str
85              
86             The status of the cluster. The valid values are C<ACTIVE> or
87             C<INACTIVE>. C<ACTIVE> indicates that you can register container
88             instances with the cluster and the associated instances can accept
89             tasks.
90              
91              
92              
93             =head1 SEE ALSO
94              
95             This class forms part of L<Paws>, describing an object used in L<Paws::ECS>
96              
97             =head1 BUGS and CONTRIBUTIONS
98              
99             The source code is located here: https://github.com/pplu/aws-sdk-perl
100              
101             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
102              
103             =cut
104