Network.AWS.ECS.DeregisterContainerInstance

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.

Creating a Request

deregisterContainerInstance

Arguments

:: Text

derContainerInstance

-> DeregisterContainerInstance

Creates a value of DeregisterContainerInstance with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• derCluster - 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.
• derForce - 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.
• derContainerInstance - 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 AWS 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 .

data DeregisterContainerInstance

See: deregisterContainerInstance smart constructor.

Instances

Eq DeregisterContainerInstance

Methods

(==) :: DeregisterContainerInstance -> DeregisterContainerInstance -> Bool

(/=) :: DeregisterContainerInstance -> DeregisterContainerInstance -> Bool

Data DeregisterContainerInstance

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeregisterContainerInstance -> c DeregisterContainerInstance

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeregisterContainerInstance

toConstr :: DeregisterContainerInstance -> Constr

dataTypeOf :: DeregisterContainerInstance -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeregisterContainerInstance)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeregisterContainerInstance)

gmapT :: (forall b. Data b => b -> b) -> DeregisterContainerInstance -> DeregisterContainerInstance

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeregisterContainerInstance -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeregisterContainerInstance -> r

gmapQ :: (forall d. Data d => d -> u) -> DeregisterContainerInstance -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeregisterContainerInstance -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeregisterContainerInstance -> m DeregisterContainerInstance

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeregisterContainerInstance -> m DeregisterContainerInstance

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeregisterContainerInstance -> m DeregisterContainerInstance

Read DeregisterContainerInstance

Methods

readsPrec :: Int -> ReadS DeregisterContainerInstance

readList :: ReadS [DeregisterContainerInstance]

readPrec :: ReadPrec DeregisterContainerInstance

readListPrec :: ReadPrec [DeregisterContainerInstance]

Show DeregisterContainerInstance

Methods

showsPrec :: Int -> DeregisterContainerInstance -> ShowS

show :: DeregisterContainerInstance -> String

showList :: [DeregisterContainerInstance] -> ShowS

Generic DeregisterContainerInstance

Associated Types

type Rep DeregisterContainerInstance :: * -> *

Methods

from :: DeregisterContainerInstance -> Rep DeregisterContainerInstance x

to :: Rep DeregisterContainerInstance x -> DeregisterContainerInstance

Hashable DeregisterContainerInstance

Methods

hashWithSalt :: Int -> DeregisterContainerInstance -> Int

hash :: DeregisterContainerInstance -> Int

ToJSON DeregisterContainerInstance

Methods

toJSON :: DeregisterContainerInstance -> Value

toEncoding :: DeregisterContainerInstance -> Encoding

toJSONList :: [DeregisterContainerInstance] -> Value

toEncodingList :: [DeregisterContainerInstance] -> Encoding

NFData DeregisterContainerInstance

Methods

rnf :: DeregisterContainerInstance -> ()

AWSRequest DeregisterContainerInstance

Associated Types

type Rs DeregisterContainerInstance :: *

Methods

request :: DeregisterContainerInstance -> Request DeregisterContainerInstance

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DeregisterContainerInstance -> ClientResponse -> m (Response DeregisterContainerInstance)

ToHeaders DeregisterContainerInstance

Methods

toHeaders :: DeregisterContainerInstance -> [Header]

ToPath DeregisterContainerInstance

Methods

toPath :: DeregisterContainerInstance -> ByteString

ToQuery DeregisterContainerInstance

Methods

toQuery :: DeregisterContainerInstance -> QueryString

type Rep DeregisterContainerInstance

type Rep DeregisterContainerInstance = D1 * (MetaData "DeregisterContainerInstance" "Network.AWS.ECS.DeregisterContainerInstance" "amazonka-ecs-1.6.0-7CQHGOTku8B1VmTRp9KDXq" False) (C1 * (MetaCons "DeregisterContainerInstance'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_derCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_derForce") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_derContainerInstance") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))

type Rs DeregisterContainerInstance

type Rs DeregisterContainerInstance = DeregisterContainerInstanceResponse

Request Lenses

derCluster :: Lens' DeregisterContainerInstance (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.

derForce :: Lens' DeregisterContainerInstance (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.

derContainerInstance :: Lens' DeregisterContainerInstance 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 AWS 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

deregisterContainerInstanceResponse

Arguments

:: Int

dcirsResponseStatus

-> DeregisterContainerInstanceResponse

Creates a value of DeregisterContainerInstanceResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dcirsContainerInstance - The container instance that was deregistered.
• dcirsResponseStatus - -- | The response status code.

data DeregisterContainerInstanceResponse

See: deregisterContainerInstanceResponse smart constructor.

Instances

Eq DeregisterContainerInstanceResponse

Methods

(==) :: DeregisterContainerInstanceResponse -> DeregisterContainerInstanceResponse -> Bool

(/=) :: DeregisterContainerInstanceResponse -> DeregisterContainerInstanceResponse -> Bool

Data DeregisterContainerInstanceResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeregisterContainerInstanceResponse -> c DeregisterContainerInstanceResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeregisterContainerInstanceResponse

toConstr :: DeregisterContainerInstanceResponse -> Constr

dataTypeOf :: DeregisterContainerInstanceResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DeregisterContainerInstanceResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeregisterContainerInstanceResponse)

gmapT :: (forall b. Data b => b -> b) -> DeregisterContainerInstanceResponse -> DeregisterContainerInstanceResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeregisterContainerInstanceResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeregisterContainerInstanceResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DeregisterContainerInstanceResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeregisterContainerInstanceResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeregisterContainerInstanceResponse -> m DeregisterContainerInstanceResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeregisterContainerInstanceResponse -> m DeregisterContainerInstanceResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeregisterContainerInstanceResponse -> m DeregisterContainerInstanceResponse

Read DeregisterContainerInstanceResponse

Methods

readsPrec :: Int -> ReadS DeregisterContainerInstanceResponse

readList :: ReadS [DeregisterContainerInstanceResponse]

readPrec :: ReadPrec DeregisterContainerInstanceResponse

readListPrec :: ReadPrec [DeregisterContainerInstanceResponse]

Show DeregisterContainerInstanceResponse

Methods

showsPrec :: Int -> DeregisterContainerInstanceResponse -> ShowS

show :: DeregisterContainerInstanceResponse -> String

showList :: [DeregisterContainerInstanceResponse] -> ShowS

Generic DeregisterContainerInstanceResponse

Associated Types

type Rep DeregisterContainerInstanceResponse :: * -> *

Methods

from :: DeregisterContainerInstanceResponse -> Rep DeregisterContainerInstanceResponse x

to :: Rep DeregisterContainerInstanceResponse x -> DeregisterContainerInstanceResponse

NFData DeregisterContainerInstanceResponse

Methods

rnf :: DeregisterContainerInstanceResponse -> ()

type Rep DeregisterContainerInstanceResponse

type Rep DeregisterContainerInstanceResponse = D1 * (MetaData "DeregisterContainerInstanceResponse" "Network.AWS.ECS.DeregisterContainerInstance" "amazonka-ecs-1.6.0-7CQHGOTku8B1VmTRp9KDXq" False) (C1 * (MetaCons "DeregisterContainerInstanceResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dcirsContainerInstance") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe ContainerInstance))) (S1 * (MetaSel (Just Symbol "_dcirsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

dcirsContainerInstance :: Lens' DeregisterContainerInstanceResponse (Maybe ContainerInstance)

The container instance that was deregistered.

dcirsResponseStatus :: Lens' DeregisterContainerInstanceResponse Int

• - | The response status code.