Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ECS.DeregisterContainerInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.

If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration. That prevents any orphaned tasks from consuming resources.

Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance. If you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.

If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).

Synopsis

Creating a Request

data DeregisterContainerInstance Source #

See: newDeregisterContainerInstance smart constructor.

Constructors

DeregisterContainerInstance'

Fields

cluster :: Maybe Text
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.
force :: Maybe Bool
Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.
containerInstance :: Text
The container instance ID or full ARN of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

Instances

Instances details

Eq DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods (==) :: DeregisterContainerInstance -> DeregisterContainerInstance -> Bool # (/=) :: DeregisterContainerInstance -> DeregisterContainerInstance -> Bool #
Read DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods readsPrec :: Int -> ReadS DeregisterContainerInstance # readList :: ReadS [DeregisterContainerInstance] # readPrec :: ReadPrec DeregisterContainerInstance # readListPrec :: ReadPrec [DeregisterContainerInstance] #
Show DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods showsPrec :: Int -> DeregisterContainerInstance -> ShowS # show :: DeregisterContainerInstance -> String # showList :: [DeregisterContainerInstance] -> ShowS #
Generic DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Associated Types type Rep DeregisterContainerInstance :: Type -> Type # Methods from :: DeregisterContainerInstance -> Rep DeregisterContainerInstance x # to :: Rep DeregisterContainerInstance x -> DeregisterContainerInstance #
NFData DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods rnf :: DeregisterContainerInstance -> () #
Hashable DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods hashWithSalt :: Int -> DeregisterContainerInstance -> Int # hash :: DeregisterContainerInstance -> Int #
ToJSON DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods toJSON :: DeregisterContainerInstance -> Value # toEncoding :: DeregisterContainerInstance -> Encoding # toJSONList :: [DeregisterContainerInstance] -> Value # toEncodingList :: [DeregisterContainerInstance] -> Encoding #
AWSRequest DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Associated Types type AWSResponse DeregisterContainerInstance # Methods request :: DeregisterContainerInstance -> Request DeregisterContainerInstance # response :: MonadResource m => Logger -> Service -> Proxy DeregisterContainerInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeregisterContainerInstance))) #
ToHeaders DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods toHeaders :: DeregisterContainerInstance -> [Header] #
ToPath DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods toPath :: DeregisterContainerInstance -> ByteString #
ToQuery DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods toQuery :: DeregisterContainerInstance -> QueryString #
type Rep DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance type Rep DeregisterContainerInstance = D1 ('MetaData "DeregisterContainerInstance" "Amazonka.ECS.DeregisterContainerInstance" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "DeregisterContainerInstance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "force") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "containerInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse DeregisterContainerInstance Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance type AWSResponse DeregisterContainerInstance = DeregisterContainerInstanceResponse

newDeregisterContainerInstance Source #

Arguments

:: Text	`$sel:containerInstance:DeregisterContainerInstance'`
-> DeregisterContainerInstance

Create a value of DeregisterContainerInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cluster:DeregisterContainerInstance', deregisterContainerInstance_cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

$sel:force:DeregisterContainerInstance', deregisterContainerInstance_force - Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

$sel:containerInstance:DeregisterContainerInstance', deregisterContainerInstance_containerInstance - The container instance ID or full ARN of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

Request Lenses

deregisterContainerInstance_cluster :: Lens' DeregisterContainerInstance (Maybe Text) Source #

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to deregister. If you do not specify a cluster, the default cluster is assumed.

deregisterContainerInstance_force :: Lens' DeregisterContainerInstance (Maybe Bool) Source #

Forces the deregistration of the container instance. If you have tasks running on the container instance when you deregister it with the force option, these tasks remain running until you terminate the instance or the tasks stop through some other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If an orphaned task on your container instance is part of an Amazon ECS service, then the service scheduler starts another copy of that task, on a different container instance if possible.

Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer target group are deregistered. They begin connection draining according to the settings on the load balancer or target group.

deregisterContainerInstance_containerInstance :: Lens' DeregisterContainerInstance Text Source #

The container instance ID or full ARN of the container instance to deregister. The ARN contains the arn:aws:ecs namespace, followed by the Region of the container instance, the Amazon Web Services account ID of the container instance owner, the container-instance namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID.

Destructuring the Response

data DeregisterContainerInstanceResponse Source #

See: newDeregisterContainerInstanceResponse smart constructor.

Constructors

DeregisterContainerInstanceResponse'
Fields containerInstance :: Maybe ContainerInstance The container instance that was deregistered. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DeregisterContainerInstanceResponse Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods (==) :: DeregisterContainerInstanceResponse -> DeregisterContainerInstanceResponse -> Bool # (/=) :: DeregisterContainerInstanceResponse -> DeregisterContainerInstanceResponse -> Bool #
Read DeregisterContainerInstanceResponse Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods readsPrec :: Int -> ReadS DeregisterContainerInstanceResponse # readList :: ReadS [DeregisterContainerInstanceResponse] # readPrec :: ReadPrec DeregisterContainerInstanceResponse # readListPrec :: ReadPrec [DeregisterContainerInstanceResponse] #
Show DeregisterContainerInstanceResponse Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods showsPrec :: Int -> DeregisterContainerInstanceResponse -> ShowS # show :: DeregisterContainerInstanceResponse -> String # showList :: [DeregisterContainerInstanceResponse] -> ShowS #
Generic DeregisterContainerInstanceResponse Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Associated Types type Rep DeregisterContainerInstanceResponse :: Type -> Type # Methods from :: DeregisterContainerInstanceResponse -> Rep DeregisterContainerInstanceResponse x # to :: Rep DeregisterContainerInstanceResponse x -> DeregisterContainerInstanceResponse #
NFData DeregisterContainerInstanceResponse Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance Methods rnf :: DeregisterContainerInstanceResponse -> () #
type Rep DeregisterContainerInstanceResponse Source #
Instance details Defined in Amazonka.ECS.DeregisterContainerInstance type Rep DeregisterContainerInstanceResponse = D1 ('MetaData "DeregisterContainerInstanceResponse" "Amazonka.ECS.DeregisterContainerInstance" "libZSservicesZSamazonka-ecsZSamazonka-ecs" 'False) (C1 ('MetaCons "DeregisterContainerInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "containerInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeregisterContainerInstanceResponse Source #

Arguments

:: Int	`$sel:httpStatus:DeregisterContainerInstanceResponse'`
-> DeregisterContainerInstanceResponse

Create a value of DeregisterContainerInstanceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:containerInstance:DeregisterContainerInstance', deregisterContainerInstanceResponse_containerInstance - The container instance that was deregistered.

$sel:httpStatus:DeregisterContainerInstanceResponse', deregisterContainerInstanceResponse_httpStatus - The response's http status code.

Response Lenses

deregisterContainerInstanceResponse_containerInstance :: Lens' DeregisterContainerInstanceResponse (Maybe ContainerInstance) Source #

The container instance that was deregistered.

deregisterContainerInstanceResponse_httpStatus :: Lens' DeregisterContainerInstanceResponse Int Source #

The response's http status code.