Network.AWS.ECS.DeregisterContainerInstance

Deregisters an Amazon ECS container instance from the specified cluster. This instance will no longer be 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 to avoid 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.

When you terminate a container instance, it is automatically deregistered from your cluster.

See: AWS API Reference for DeregisterContainerInstance.

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
• derForce
• derContainerInstance

data DeregisterContainerInstance

See: deregisterContainerInstance smart constructor.

Instances

Eq DeregisterContainerInstance

Data DeregisterContainerInstance

Read DeregisterContainerInstance

Show DeregisterContainerInstance

Generic DeregisterContainerInstance

ToJSON DeregisterContainerInstance

AWSRequest DeregisterContainerInstance

ToPath DeregisterContainerInstance

ToHeaders DeregisterContainerInstance

ToQuery DeregisterContainerInstance

Typeable * DeregisterContainerInstance

type Rep 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 you want to deregister. If you do not specify a cluster, the default cluster is assumed.

derForce :: Lens' DeregisterContainerInstance (Maybe Bool)

Force 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 and they will continue to pass Elastic Load Balancing load balancer health checks 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 will start another copy of that task on a different container instance if possible.

derContainerInstance :: Lens' DeregisterContainerInstance Text

The container instance UUID or full Amazon Resource Name (ARN) of the container instance you want 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 UUID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_UUID.

Destructuring the Response

deregisterContainerInstanceResponse

Arguments

:: Int

dcirsStatus

-> 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
• dcirsStatus

data DeregisterContainerInstanceResponse

See: deregisterContainerInstanceResponse smart constructor.

Instances

Eq DeregisterContainerInstanceResponse

Data DeregisterContainerInstanceResponse

Read DeregisterContainerInstanceResponse

Show DeregisterContainerInstanceResponse

Generic DeregisterContainerInstanceResponse

Typeable * DeregisterContainerInstanceResponse

type Rep DeregisterContainerInstanceResponse

Response Lenses

dcirsContainerInstance :: Lens' DeregisterContainerInstanceResponse (Maybe ContainerInstance)

Undocumented member.

dcirsStatus :: Lens' DeregisterContainerInstanceResponse Int

The response status code.