Network.AWS.ECS.UpdateService

Modify the desired count or task definition used in a service.

You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.

You can use UpdateService to modify your task definition and deploy a new version of your service, one task at a time. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running. Because UpdateService starts a new version of the task before stopping an old version, your cluster must have capacity to support one more instantiation of the task when UpdateService is run. If your cluster cannot support another instantiation of the task used in your service, you can reduce the desired count of your service by one before modifying the task definition.

When UpdateService replaces a task during an update, the equivalent of 'docker stop' is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.

When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:

• Determine which of the container instances in your cluster can support your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
• Sort the valid container instances by the fewest number of running tasks for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
• Place the new service task on a valid container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.

See: AWS API Reference for UpdateService.

Creating a Request

updateService

Arguments

:: Text

usService

-> UpdateService

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

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

• usCluster
• usDesiredCount
• usTaskDefinition
• usService

data UpdateService

See: updateService smart constructor.

Instances

Eq UpdateService

Methods

(==) :: UpdateService -> UpdateService -> Bool

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

Data UpdateService

Methods

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

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

toConstr :: UpdateService -> Constr

dataTypeOf :: UpdateService -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateService

Methods

readsPrec :: Int -> ReadS UpdateService

readList :: ReadS [UpdateService]

readPrec :: ReadPrec UpdateService

readListPrec :: ReadPrec [UpdateService]

Show UpdateService

Methods

showsPrec :: Int -> UpdateService -> ShowS

show :: UpdateService -> String

showList :: [UpdateService] -> ShowS

Generic UpdateService

Associated Types

type Rep UpdateService :: * -> *

Methods

from :: UpdateService -> Rep UpdateService x

to :: Rep UpdateService x -> UpdateService

ToJSON UpdateService

Methods

toJSON :: UpdateService -> Value

toEncoding :: UpdateService -> Encoding

toJSONList :: [UpdateService] -> Value

toEncodingList :: [UpdateService] -> Encoding

AWSRequest UpdateService

Associated Types

type Rs UpdateService :: *

Methods

request :: UpdateService -> Request UpdateService

response :: MonadResource m => Logger -> Service -> Proxy * UpdateService -> ClientResponse -> m (Response UpdateService)

ToQuery UpdateService

Methods

toQuery :: UpdateService -> QueryString

ToPath UpdateService

Methods

toPath :: UpdateService -> ByteString

ToHeaders UpdateService

Methods

toHeaders :: UpdateService -> [Header]

type Rep UpdateService

type Rep UpdateService = D1 (MetaData "UpdateService" "Network.AWS.ECS.UpdateService" "amazonka-ecs-1.3.7-Ha9ctxkGfT14fSx4QrugPG" False) (C1 (MetaCons "UpdateService'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_usCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_usDesiredCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int)))) ((:*:) (S1 (MetaSel (Just Symbol "_usTaskDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_usService") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs UpdateService

type Rs UpdateService = UpdateServiceResponse

Request Lenses

usCluster :: Lens' UpdateService (Maybe Text)

The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on. If you do not specify a cluster, the default cluster is assumed.

usDesiredCount :: Lens' UpdateService (Maybe Int)

The number of instantiations of the task to place and keep running in your service.

usTaskDefinition :: Lens' UpdateService (Maybe Text)

The family and revision ('family:revision') or full Amazon Resource Name (ARN) of the task definition to run in your service. If a revision is not specified, the latest ACTIVE revision is used. If you modify the task definition with UpdateService, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.

usService :: Lens' UpdateService Text

The name of the service to update.

Destructuring the Response

updateServiceResponse

Arguments

:: Int

usrsResponseStatus

-> UpdateServiceResponse

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

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

• usrsService
• usrsResponseStatus

data UpdateServiceResponse

See: updateServiceResponse smart constructor.

Instances

Eq UpdateServiceResponse

Methods

(==) :: UpdateServiceResponse -> UpdateServiceResponse -> Bool

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

Data UpdateServiceResponse

Methods

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

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

toConstr :: UpdateServiceResponse -> Constr

dataTypeOf :: UpdateServiceResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateServiceResponse

Methods

readsPrec :: Int -> ReadS UpdateServiceResponse

readList :: ReadS [UpdateServiceResponse]

readPrec :: ReadPrec UpdateServiceResponse

readListPrec :: ReadPrec [UpdateServiceResponse]

Show UpdateServiceResponse

Methods

showsPrec :: Int -> UpdateServiceResponse -> ShowS

show :: UpdateServiceResponse -> String

showList :: [UpdateServiceResponse] -> ShowS

Generic UpdateServiceResponse

Associated Types

type Rep UpdateServiceResponse :: * -> *

Methods

from :: UpdateServiceResponse -> Rep UpdateServiceResponse x

to :: Rep UpdateServiceResponse x -> UpdateServiceResponse

type Rep UpdateServiceResponse

type Rep UpdateServiceResponse = D1 (MetaData "UpdateServiceResponse" "Network.AWS.ECS.UpdateService" "amazonka-ecs-1.3.7-Ha9ctxkGfT14fSx4QrugPG" False) (C1 (MetaCons "UpdateServiceResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_usrsService") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ContainerService))) (S1 (MetaSel (Just Symbol "_usrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

usrsService :: Lens' UpdateServiceResponse (Maybe ContainerService)

The full description of your service following the update call.

usrsResponseStatus :: Lens' UpdateServiceResponse Int

The response status code.