Network.AWS.ECS.CreateService

Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another instantiation of the task in the specified cluster. To update an existing service, see UpdateService.

You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition of a service with an UpdateService operation), the service scheduler uses the minimumHealthyPercent and maximumPercent parameters to determine the deployment strategy.

If the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for minimumHealthyPercent is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.

The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks, a maximumPercent value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximumPercent is 200%.

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.

Creating a Request

createService

Arguments

:: Text

cServiceName

-> Text

cTaskDefinition

-> Int

cDesiredCount

-> CreateService

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

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

• cCluster
• cClientToken
• cLoadBalancers
• cRole
• cDeploymentConfiguration
• cServiceName
• cTaskDefinition
• cDesiredCount

data CreateService

See: createService smart constructor.

Instances

Eq CreateService

Methods

(==) :: CreateService -> CreateService -> Bool

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

Data CreateService

Methods

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

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

toConstr :: CreateService -> Constr

dataTypeOf :: CreateService -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateService

Methods

readsPrec :: Int -> ReadS CreateService

readList :: ReadS [CreateService]

readPrec :: ReadPrec CreateService

readListPrec :: ReadPrec [CreateService]

Show CreateService

Methods

showsPrec :: Int -> CreateService -> ShowS

show :: CreateService -> String

showList :: [CreateService] -> ShowS

Generic CreateService

Associated Types

type Rep CreateService :: * -> *

Methods

from :: CreateService -> Rep CreateService x

to :: Rep CreateService x -> CreateService

Hashable CreateService

Methods

hashWithSalt :: Int -> CreateService -> Int

hash :: CreateService -> Int

ToJSON CreateService

Methods

toJSON :: CreateService -> Value

toEncoding :: CreateService -> Encoding

toJSONList :: [CreateService] -> Value

toEncodingList :: [CreateService] -> Encoding

NFData CreateService

Methods

rnf :: CreateService -> ()

AWSRequest CreateService

Associated Types

type Rs CreateService :: *

Methods

request :: CreateService -> Request CreateService

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

ToQuery CreateService

Methods

toQuery :: CreateService -> QueryString

ToPath CreateService

Methods

toPath :: CreateService -> ByteString

ToHeaders CreateService

Methods

toHeaders :: CreateService -> [Header]

type Rep CreateService

type Rep CreateService = D1 (MetaData "CreateService" "Network.AWS.ECS.CreateService" "amazonka-ecs-1.4.3-EI6LaLn2ihbBOjQBfPY85t" False) (C1 (MetaCons "CreateService'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cClientToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cLoadBalancers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [LoadBalancer]))) (S1 (MetaSel (Just Symbol "_cRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cDeploymentConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DeploymentConfiguration))) (S1 (MetaSel (Just Symbol "_cServiceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cTaskDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cDesiredCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))))

type Rs CreateService

type Rs CreateService = CreateServiceResponse

Request Lenses

cCluster :: Lens' CreateService (Maybe Text)

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

cClientToken :: Lens' CreateService (Maybe Text)

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

cLoadBalancers :: Lens' CreateService [LoadBalancer]

A list of load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

cRole :: Lens' CreateService (Maybe Text)

The name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf. This parameter is only required if you are using a load balancer with your service.

cDeploymentConfiguration :: Lens' CreateService (Maybe DeploymentConfiguration)

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

cServiceName :: Lens' CreateService Text

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a region or across multiple regions.

cTaskDefinition :: Lens' CreateService 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.

cDesiredCount :: Lens' CreateService Int

The number of instantiations of the specified task definition to place and keep running on your cluster.

Destructuring the Response

createServiceResponse

Arguments

:: Int

csrsResponseStatus

-> CreateServiceResponse

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

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

• csrsService
• csrsResponseStatus

data CreateServiceResponse

See: createServiceResponse smart constructor.

Instances

Eq CreateServiceResponse

Methods

(==) :: CreateServiceResponse -> CreateServiceResponse -> Bool

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

Data CreateServiceResponse

Methods

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

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

toConstr :: CreateServiceResponse -> Constr

dataTypeOf :: CreateServiceResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateServiceResponse

Methods

readsPrec :: Int -> ReadS CreateServiceResponse

readList :: ReadS [CreateServiceResponse]

readPrec :: ReadPrec CreateServiceResponse

readListPrec :: ReadPrec [CreateServiceResponse]

Show CreateServiceResponse

Methods

showsPrec :: Int -> CreateServiceResponse -> ShowS

show :: CreateServiceResponse -> String

showList :: [CreateServiceResponse] -> ShowS

Generic CreateServiceResponse

Associated Types

type Rep CreateServiceResponse :: * -> *

Methods

from :: CreateServiceResponse -> Rep CreateServiceResponse x

to :: Rep CreateServiceResponse x -> CreateServiceResponse

NFData CreateServiceResponse

Methods

rnf :: CreateServiceResponse -> ()

type Rep CreateServiceResponse

type Rep CreateServiceResponse = D1 (MetaData "CreateServiceResponse" "Network.AWS.ECS.CreateService" "amazonka-ecs-1.4.3-EI6LaLn2ihbBOjQBfPY85t" False) (C1 (MetaCons "CreateServiceResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_csrsService") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ContainerService))) (S1 (MetaSel (Just Symbol "_csrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

csrsService :: Lens' CreateServiceResponse (Maybe ContainerService)

The full description of your service following the create call.

csrsResponseStatus :: Lens' CreateServiceResponse Int

The response status code.