| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::ContainerInstance; | ||
| 3 | use Moose; | ||
| 4 | has AgentConnected => (is => 'ro', isa => 'Bool', request_name => 'agentConnected', traits => ['NameInRequest']); | ||
| 5 | has AgentUpdateStatus => (is => 'ro', isa => 'Str', request_name => 'agentUpdateStatus', traits => ['NameInRequest']); | ||
| 6 | has Attachments => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Attachment]', request_name => 'attachments', traits => ['NameInRequest']); | ||
| 7 | has Attributes => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Attribute]', request_name => 'attributes', traits => ['NameInRequest']); | ||
| 8 | has CapacityProviderName => (is => 'ro', isa => 'Str', request_name => 'capacityProviderName', traits => ['NameInRequest']); | ||
| 9 | has ContainerInstanceArn => (is => 'ro', isa => 'Str', request_name => 'containerInstanceArn', traits => ['NameInRequest']); | ||
| 10 | has Ec2InstanceId => (is => 'ro', isa => 'Str', request_name => 'ec2InstanceId', traits => ['NameInRequest']); | ||
| 11 | has PendingTasksCount => (is => 'ro', isa => 'Int', request_name => 'pendingTasksCount', traits => ['NameInRequest']); | ||
| 12 | has RegisteredAt => (is => 'ro', isa => 'Str', request_name => 'registeredAt', traits => ['NameInRequest']); | ||
| 13 | has RegisteredResources => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Resource]', request_name => 'registeredResources', traits => ['NameInRequest']); | ||
| 14 | has RemainingResources => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Resource]', request_name => 'remainingResources', traits => ['NameInRequest']); | ||
| 15 | has RunningTasksCount => (is => 'ro', isa => 'Int', request_name => 'runningTasksCount', traits => ['NameInRequest']); | ||
| 16 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 17 | has StatusReason => (is => 'ro', isa => 'Str', request_name => 'statusReason', traits => ['NameInRequest']); | ||
| 18 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Tag]', request_name => 'tags', traits => ['NameInRequest']); | ||
| 19 | has Version => (is => 'ro', isa => 'Int', request_name => 'version', traits => ['NameInRequest']); | ||
| 20 | has VersionInfo => (is => 'ro', isa => 'Paws::ECS::VersionInfo', request_name => 'versionInfo', traits => ['NameInRequest']); | ||
| 21 | |||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::ECS::ContainerInstance | ||
| 29 | |||
| 30 | =head1 USAGE | ||
| 31 | |||
| 32 | This class represents one of two things: | ||
| 33 | |||
| 34 | =head3 Arguments in a call to a service | ||
| 35 | |||
| 36 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 37 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 38 | |||
| 39 | As an example, if Att1 is expected to be a Paws::ECS::ContainerInstance object: | ||
| 40 | |||
| 41 | $service_obj->Method(Att1 => { AgentConnected => $value, ..., VersionInfo => $value }); | ||
| 42 | |||
| 43 | =head3 Results returned from an API call | ||
| 44 | |||
| 45 | Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::ContainerInstance object: | ||
| 46 | |||
| 47 | $result = $service_obj->Method(...); | ||
| 48 | $result->Att1->AgentConnected | ||
| 49 | |||
| 50 | =head1 DESCRIPTION | ||
| 51 | |||
| 52 | An EC2 instance that is running the Amazon ECS agent and has been | ||
| 53 | registered with a cluster. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 AgentConnected => Bool | ||
| 59 | |||
| 60 | This parameter returns C<true> if the agent is connected to Amazon ECS. | ||
| 61 | Registered instances with an agent that may be unhealthy or stopped | ||
| 62 | return C<false>. Only instances connected to an agent can accept | ||
| 63 | placement requests. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 AgentUpdateStatus => Str | ||
| 67 | |||
| 68 | The status of the most recent agent update. If an update has never been | ||
| 69 | requested, this value is C<NULL>. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 Attachments => ArrayRef[L<Paws::ECS::Attachment>] | ||
| 73 | |||
| 74 | The resources attached to a container instance, such as elastic network | ||
| 75 | interfaces. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 Attributes => ArrayRef[L<Paws::ECS::Attribute>] | ||
| 79 | |||
| 80 | The attributes set for the container instance, either by the Amazon ECS | ||
| 81 | container agent at instance registration or manually with the | ||
| 82 | PutAttributes operation. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 CapacityProviderName => Str | ||
| 86 | |||
| 87 | The capacity provider associated with the container instance. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 ContainerInstanceArn => Str | ||
| 91 | |||
| 92 | The Amazon Resource Name (ARN) of the container instance. The ARN | ||
| 93 | contains the C<arn:aws:ecs> namespace, followed by the Region of the | ||
| 94 | container instance, the AWS account ID of the container instance owner, | ||
| 95 | the C<container-instance> namespace, and then the container instance | ||
| 96 | ID. For example, | ||
| 97 | C<arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID>. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 Ec2InstanceId => Str | ||
| 101 | |||
| 102 | The ID of the container instance. For Amazon EC2 instances, this value | ||
| 103 | is the Amazon EC2 instance ID. For external instances, this value is | ||
| 104 | the AWS Systems Manager managed instance ID. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 PendingTasksCount => Int | ||
| 108 | |||
| 109 | The number of tasks on the container instance that are in the | ||
| 110 | C<PENDING> status. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 RegisteredAt => Str | ||
| 114 | |||
| 115 | The Unix timestamp for when the container instance was registered. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 RegisteredResources => ArrayRef[L<Paws::ECS::Resource>] | ||
| 119 | |||
| 120 | For CPU and memory resource types, this parameter describes the amount | ||
| 121 | of each resource that was available on the container instance when the | ||
| 122 | container agent registered it with Amazon ECS. This value represents | ||
| 123 | the total amount of CPU and memory that can be allocated on this | ||
| 124 | container instance to tasks. For port resource types, this parameter | ||
| 125 | describes the ports that were reserved by the Amazon ECS container | ||
| 126 | agent when it registered the container instance with Amazon ECS. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 RemainingResources => ArrayRef[L<Paws::ECS::Resource>] | ||
| 130 | |||
| 131 | For CPU and memory resource types, this parameter describes the | ||
| 132 | remaining CPU and memory that has not already been allocated to tasks | ||
| 133 | and is therefore available for new tasks. For port resource types, this | ||
| 134 | parameter describes the ports that were reserved by the Amazon ECS | ||
| 135 | container agent (at instance registration time) and any task containers | ||
| 136 | that have reserved port mappings on the host (with the C<host> or | ||
| 137 | C<bridge> network mode). Any port that is not specified here is | ||
| 138 | available for new tasks. | ||
| 139 | |||
| 140 | |||
| 141 | =head2 RunningTasksCount => Int | ||
| 142 | |||
| 143 | The number of tasks on the container instance that are in the | ||
| 144 | C<RUNNING> status. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 Status => Str | ||
| 148 | |||
| 149 | The status of the container instance. The valid values are | ||
| 150 | C<REGISTERING>, C<REGISTRATION_FAILED>, C<ACTIVE>, C<INACTIVE>, | ||
| 151 | C<DEREGISTERING>, or C<DRAINING>. | ||
| 152 | |||
| 153 | If your account has opted in to the C<awsvpcTrunking> account setting, | ||
| 154 | then any newly registered container instance will transition to a | ||
| 155 | C<REGISTERING> status while the trunk elastic network interface is | ||
| 156 | provisioned for the instance. If the registration fails, the instance | ||
| 157 | will transition to a C<REGISTRATION_FAILED> status. You can describe | ||
| 158 | the container instance and see the reason for failure in the | ||
| 159 | C<statusReason> parameter. Once the container instance is terminated, | ||
| 160 | the instance transitions to a C<DEREGISTERING> status while the trunk | ||
| 161 | elastic network interface is deprovisioned. The instance then | ||
| 162 | transitions to an C<INACTIVE> status. | ||
| 163 | |||
| 164 | The C<ACTIVE> status indicates that the container instance can accept | ||
| 165 | tasks. The C<DRAINING> indicates that new tasks are not placed on the | ||
| 166 | container instance and any service tasks running on the container | ||
| 167 | instance are removed if possible. For more information, see Container | ||
| 168 | Instance Draining | ||
| 169 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html) | ||
| 170 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 171 | |||
| 172 | |||
| 173 | =head2 StatusReason => Str | ||
| 174 | |||
| 175 | The reason that the container instance reached its current status. | ||
| 176 | |||
| 177 | |||
| 178 | =head2 Tags => ArrayRef[L<Paws::ECS::Tag>] | ||
| 179 | |||
| 180 | The metadata that you apply to the container instance to help you | ||
| 181 | categorize and organize them. Each tag consists of a key and an | ||
| 182 | optional value, both of which you define. | ||
| 183 | |||
| 184 | The following basic restrictions apply to tags: | ||
| 185 | |||
| 186 | =over | ||
| 187 | |||
| 188 | =item * | ||
| 189 | |||
| 190 | Maximum number of tags per resource - 50 | ||
| 191 | |||
| 192 | =item * | ||
| 193 | |||
| 194 | For each resource, each tag key must be unique, and each tag key can | ||
| 195 | have only one value. | ||
| 196 | |||
| 197 | =item * | ||
| 198 | |||
| 199 | Maximum key length - 128 Unicode characters in UTF-8 | ||
| 200 | |||
| 201 | =item * | ||
| 202 | |||
| 203 | Maximum value length - 256 Unicode characters in UTF-8 | ||
| 204 | |||
| 205 | =item * | ||
| 206 | |||
| 207 | If your tagging schema is used across multiple services and resources, | ||
| 208 | remember that other services may have restrictions on allowed | ||
| 209 | characters. Generally allowed characters are: letters, numbers, and | ||
| 210 | spaces representable in UTF-8, and the following characters: + - = . _ | ||
| 211 | : / @. | ||
| 212 | |||
| 213 | =item * | ||
| 214 | |||
| 215 | Tag keys and values are case-sensitive. | ||
| 216 | |||
| 217 | =item * | ||
| 218 | |||
| 219 | Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of | ||
| 220 | such as a prefix for either keys or values as it is reserved for AWS | ||
| 221 | use. You cannot edit or delete tag keys or values with this prefix. | ||
| 222 | Tags with this prefix do not count against your tags per resource | ||
| 223 | limit. | ||
| 224 | |||
| 225 | =back | ||
| 226 | |||
| 227 | |||
| 228 | |||
| 229 | =head2 Version => Int | ||
| 230 | |||
| 231 | The version counter for the container instance. Every time a container | ||
| 232 | instance experiences a change that triggers a CloudWatch event, the | ||
| 233 | version counter is incremented. If you are replicating your Amazon ECS | ||
| 234 | container instance state with CloudWatch Events, you can compare the | ||
| 235 | version of a container instance reported by the Amazon ECS APIs with | ||
| 236 | the version reported in CloudWatch Events for the container instance | ||
| 237 | (inside the C<detail> object) to verify that the version in your event | ||
| 238 | stream is current. | ||
| 239 | |||
| 240 | |||
| 241 | =head2 VersionInfo => L<Paws::ECS::VersionInfo> | ||
| 242 | |||
| 243 | The version information for the Amazon ECS container agent and Docker | ||
| 244 | daemon running on the container instance. | ||
| 245 | |||
| 246 | |||
| 247 | |||
| 248 | =head1 SEE ALSO | ||
| 249 | |||
| 250 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 251 | |||
| 252 | =head1 BUGS and CONTRIBUTIONS | ||
| 253 | |||
| 254 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 255 | |||
| 256 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 257 | |||
| 258 | =cut | ||
| 259 |