File Coverage

blib/lib/Paws/ECS/DeregisterContainerInstance.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::DeregisterContainerInstance;
3 1     1   620 use Moose;
  1         4  
  1         13  
4             has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' );
5             has ContainerInstance => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'containerInstance' , required => 1);
6             has Force => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'force' );
7              
8 1     1   11218 use MooseX::ClassAttribute;
  1         6  
  1         15  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeregisterContainerInstance');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::DeregisterContainerInstanceResponse');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::ECS::DeregisterContainerInstance - Arguments for method DeregisterContainerInstance on Paws::ECS
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method DeregisterContainerInstance on the
24             Amazon EC2 Container Service service. Use the attributes of this class
25             as arguments to method DeregisterContainerInstance.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeregisterContainerInstance.
28              
29             As an example:
30              
31             $service_obj->DeregisterContainerInstance(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 Cluster => Str
39              
40             The short name or full Amazon Resource Name (ARN) of the cluster that
41             hosts the container instance to deregister. If you do not specify a
42             cluster, the default cluster is assumed.
43              
44              
45              
46             =head2 B<REQUIRED> ContainerInstance => Str
47              
48             The container instance ID or full Amazon Resource Name (ARN) of the
49             container instance to deregister. The ARN contains the C<arn:aws:ecs>
50             namespace, followed by the region of the container instance, the AWS
51             account ID of the container instance owner, the C<container-instance>
52             namespace, and then the container instance ID. For example,
53             C<arn:aws:ecs:I<region>:I<aws_account_id>:container-instance/I<container_instance_ID>
54             >.
55              
56              
57              
58             =head2 Force => Bool
59              
60             Forces the deregistration of the container instance. If you have tasks
61             running on the container instance when you deregister it with the
62             C<force> option, these tasks remain running until you terminate the
63             instance or the tasks stop through some other means, but they are
64             orphaned (no longer monitored or accounted for by Amazon ECS). If an
65             orphaned task on your container instance is part of an Amazon ECS
66             service, then the service scheduler starts another copy of that task,
67             on a different container instance if possible.
68              
69             Any containers in orphaned service tasks that are registered with a
70             Classic Load Balancer or an Application Load Balancer target group are
71             deregistered, and they will begin connection draining according to the
72             settings on the load balancer or target group.
73              
74              
75              
76              
77             =head1 SEE ALSO
78              
79             This class forms part of L<Paws>, documenting arguments for method DeregisterContainerInstance in L<Paws::ECS>
80              
81             =head1 BUGS and CONTRIBUTIONS
82              
83             The source code is located here: https://github.com/pplu/aws-sdk-perl
84              
85             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
86              
87             =cut
88