File Coverage

blib/lib/Paws/ECS/ContainerInstance.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::ContainerInstance;
2 1     1   514 use Moose;
  1         5  
  1         10  
3             has AgentConnected => (is => 'ro', isa => 'Bool', request_name => 'agentConnected', traits => ['NameInRequest']);
4             has AgentUpdateStatus => (is => 'ro', isa => 'Str', request_name => 'agentUpdateStatus', traits => ['NameInRequest']);
5             has Attributes => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Attribute]', request_name => 'attributes', traits => ['NameInRequest']);
6             has ContainerInstanceArn => (is => 'ro', isa => 'Str', request_name => 'containerInstanceArn', traits => ['NameInRequest']);
7             has Ec2InstanceId => (is => 'ro', isa => 'Str', request_name => 'ec2InstanceId', traits => ['NameInRequest']);
8             has PendingTasksCount => (is => 'ro', isa => 'Int', request_name => 'pendingTasksCount', traits => ['NameInRequest']);
9             has RegisteredAt => (is => 'ro', isa => 'Str', request_name => 'registeredAt', traits => ['NameInRequest']);
10             has RegisteredResources => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Resource]', request_name => 'registeredResources', traits => ['NameInRequest']);
11             has RemainingResources => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Resource]', request_name => 'remainingResources', traits => ['NameInRequest']);
12             has RunningTasksCount => (is => 'ro', isa => 'Int', request_name => 'runningTasksCount', traits => ['NameInRequest']);
13             has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']);
14             has Version => (is => 'ro', isa => 'Int', request_name => 'version', traits => ['NameInRequest']);
15             has VersionInfo => (is => 'ro', isa => 'Paws::ECS::VersionInfo', request_name => 'versionInfo', traits => ['NameInRequest']);
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::ECS::ContainerInstance
23              
24             =head1 USAGE
25              
26             This class represents one of two things:
27              
28             =head3 Arguments in a call to a service
29              
30             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31             Each attribute should be used as a named argument in the calls that expect this type of object.
32              
33             As an example, if Att1 is expected to be a Paws::ECS::ContainerInstance object:
34              
35             $service_obj->Method(Att1 => { AgentConnected => $value, ..., VersionInfo => $value });
36              
37             =head3 Results returned from an API call
38              
39             Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::ContainerInstance object:
40              
41             $result = $service_obj->Method(...);
42             $result->Att1->AgentConnected
43              
44             =head1 DESCRIPTION
45              
46             An EC2 instance that is running the Amazon ECS agent and has been
47             registered with a cluster.
48              
49             =head1 ATTRIBUTES
50              
51              
52             =head2 AgentConnected => Bool
53              
54             This parameter returns C<true> if the agent is actually connected to
55             Amazon ECS. Registered instances with an agent that may be unhealthy or
56             stopped return C<false>, and instances without a connected agent cannot
57             accept placement requests.
58              
59              
60             =head2 AgentUpdateStatus => Str
61              
62             The status of the most recent agent update. If an update has never been
63             requested, this value is C<NULL>.
64              
65              
66             =head2 Attributes => ArrayRef[L<Paws::ECS::Attribute>]
67              
68             The attributes set for the container instance, either by the Amazon ECS
69             container agent at instance registration or manually with the
70             PutAttributes operation.
71              
72              
73             =head2 ContainerInstanceArn => Str
74              
75             The Amazon Resource Name (ARN) of the container instance. The ARN
76             contains the C<arn:aws:ecs> namespace, followed by the region of the
77             container instance, the AWS account ID of the container instance owner,
78             the C<container-instance> namespace, and then the container instance
79             ID. For example,
80             C<arn:aws:ecs:I<region>:I<aws_account_id>:container-instance/I<container_instance_ID>
81             >.
82              
83              
84             =head2 Ec2InstanceId => Str
85              
86             The EC2 instance ID of the container instance.
87              
88              
89             =head2 PendingTasksCount => Int
90              
91             The number of tasks on the container instance that are in the
92             C<PENDING> status.
93              
94              
95             =head2 RegisteredAt => Str
96              
97             The Unix timestamp for when the container instance was registered.
98              
99              
100             =head2 RegisteredResources => ArrayRef[L<Paws::ECS::Resource>]
101              
102             For most resource types, this parameter describes the registered
103             resources on the container instance that are in use by current tasks.
104             For port resource types, this parameter describes the ports that were
105             reserved by the Amazon ECS container agent when it registered the
106             container instance with Amazon ECS.
107              
108              
109             =head2 RemainingResources => ArrayRef[L<Paws::ECS::Resource>]
110              
111             For most resource types, this parameter describes the remaining
112             resources of the container instance that are available for new tasks.
113             For port resource types, this parameter describes the ports that are
114             reserved by the Amazon ECS container agent and any containers that have
115             reserved port mappings; any port that is not specified here is
116             available for new tasks.
117              
118              
119             =head2 RunningTasksCount => Int
120              
121             The number of tasks on the container instance that are in the
122             C<RUNNING> status.
123              
124              
125             =head2 Status => Str
126              
127             The status of the container instance. The valid values are C<ACTIVE>,
128             C<INACTIVE>, or C<DRAINING>. C<ACTIVE> indicates that the container
129             instance can accept tasks. C<DRAINING> indicates that new tasks are not
130             placed on the container instance and any service tasks running on the
131             container instance are removed if possible. For more information, see
132             Container Instance Draining in the I<Amazon EC2 Container Service
133             Developer Guide>.
134              
135              
136             =head2 Version => Int
137              
138             The version counter for the container instance. Every time a container
139             instance experiences a change that triggers a CloudWatch event, the
140             version counter is incremented. If you are replicating your Amazon ECS
141             container instance state with CloudWatch events, you can compare the
142             version of a container instance reported by the Amazon ECS APIs with
143             the version reported in CloudWatch events for the container instance
144             (inside the C<detail> object) to verify that the version in your event
145             stream is current.
146              
147              
148             =head2 VersionInfo => L<Paws::ECS::VersionInfo>
149              
150             The version information for the Amazon ECS container agent and Docker
151             daemon running on the container instance.
152              
153              
154              
155             =head1 SEE ALSO
156              
157             This class forms part of L<Paws>, describing an object used in L<Paws::ECS>
158              
159             =head1 BUGS and CONTRIBUTIONS
160              
161             The source code is located here: https://github.com/pplu/aws-sdk-perl
162              
163             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
164              
165             =cut
166