« blib/lib/Paws/ECS/DeploymentController.pm
↑ Summary
blib/lib/Paws/ECS/DeregisterContainerInstanceResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::DeregisterContainerInstance; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::ECS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DeregisterContainerInstance on the | ||
| 24 | L<Amazon EC2 Container Service|Paws::ECS> 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 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $ecs = Paws->service('ECS'); | ||
| 32 | # To deregister a container instance from a cluster | ||
| 33 | # This example deregisters a container instance from the specified cluster in | ||
| 34 | # your default region. If there are still tasks running on the container | ||
| 35 | # instance, you must either stop those tasks before deregistering, or use the | ||
| 36 | # force option. | ||
| 37 | my $DeregisterContainerInstanceResponse = $ecs->DeregisterContainerInstance( | ||
| 38 | 'Cluster' => 'default', | ||
| 39 | 'ContainerInstance' => 'container_instance_UUID', | ||
| 40 | 'Force' => 1 | ||
| 41 | ); | ||
| 42 | |||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/DeregisterContainerInstance> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Cluster => Str | ||
| 51 | |||
| 52 | The short name or full Amazon Resource Name (ARN) of the cluster that | ||
| 53 | hosts the container instance to deregister. If you do not specify a | ||
| 54 | cluster, the default cluster is assumed. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> ContainerInstance => Str | ||
| 59 | |||
| 60 | The container instance ID or full ARN of the container instance to | ||
| 61 | deregister. The ARN contains the C<arn:aws:ecs> namespace, followed by | ||
| 62 | the Region of the container instance, the AWS account ID of the | ||
| 63 | container instance owner, the C<container-instance> namespace, and then | ||
| 64 | the container instance ID. For example, | ||
| 65 | C<arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID>. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 Force => Bool | ||
| 70 | |||
| 71 | Forces the deregistration of the container instance. If you have tasks | ||
| 72 | running on the container instance when you deregister it with the | ||
| 73 | C<force> option, these tasks remain running until you terminate the | ||
| 74 | instance or the tasks stop through some other means, but they are | ||
| 75 | orphaned (no longer monitored or accounted for by Amazon ECS). If an | ||
| 76 | orphaned task on your container instance is part of an Amazon ECS | ||
| 77 | service, then the service scheduler starts another copy of that task, | ||
| 78 | on a different container instance if possible. | ||
| 79 | |||
| 80 | Any containers in orphaned service tasks that are registered with a | ||
| 81 | Classic Load Balancer or an Application Load Balancer target group are | ||
| 82 | deregistered. They begin connection draining according to the settings | ||
| 83 | on the load balancer or target group. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, documenting arguments for method DeregisterContainerInstance in L<Paws::ECS> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |