{-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Network.AWS.ECS.CreateService -- Copyright : (c) 2013-2018 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- 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 copy of the task in the specified cluster. To update an existing service, see 'UpdateService' . -- -- -- In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see in the /Amazon Elastic Container Service Developer Guide/ . -- -- You can optionally specify a deployment configuration for your service. During a deployment, the service scheduler uses the @minimumHealthyPercent@ and @maximumPercent@ parameters to determine the deployment strategy. The deployment is triggered by changing the task definition or the desired count of a service with an 'UpdateService' operation. -- -- The @minimumHealthyPercent@ represents a lower limit on the number of your service's tasks that must remain in the @RUNNING@ state during a deployment, as a percentage of the @desiredCount@ (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a @desiredCount@ of four tasks and a @minimumHealthyPercent@ of 50%, the scheduler can stop two existing tasks to free up cluster capacity 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 they are 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 your service's tasks that are allowed in the @RUNNING@ or @PENDING@ state during a deployment, as a percentage of the @desiredCount@ (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service has a @desiredCount@ of four tasks and a @maximumPercent@ value of 200%, the scheduler can start 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 determines task placement in your cluster using 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). -- -- * By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the @placementStrategy@ parameter): -- -- * 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. -- -- -- -- -- module Network.AWS.ECS.CreateService ( -- * Creating a Request createService , CreateService -- * Request Lenses , cCluster , cClientToken , cPlatformVersion , cLoadBalancers , cRole , cPlacementConstraints , cPlacementStrategy , cLaunchType , cHealthCheckGracePeriodSeconds , cNetworkConfiguration , cServiceRegistries , cDeploymentConfiguration , cServiceName , cTaskDefinition , cDesiredCount -- * Destructuring the Response , createServiceResponse , CreateServiceResponse -- * Response Lenses , csrsService , csrsResponseStatus ) where import Network.AWS.ECS.Types import Network.AWS.ECS.Types.Product import Network.AWS.Lens import Network.AWS.Prelude import Network.AWS.Request import Network.AWS.Response -- | /See:/ 'createService' smart constructor. data CreateService = CreateService' { _cCluster :: !(Maybe Text) , _cClientToken :: !(Maybe Text) , _cPlatformVersion :: !(Maybe Text) , _cLoadBalancers :: !(Maybe [LoadBalancer]) , _cRole :: !(Maybe Text) , _cPlacementConstraints :: !(Maybe [PlacementConstraint]) , _cPlacementStrategy :: !(Maybe [PlacementStrategy]) , _cLaunchType :: !(Maybe LaunchType) , _cHealthCheckGracePeriodSeconds :: !(Maybe Int) , _cNetworkConfiguration :: !(Maybe NetworkConfiguration) , _cServiceRegistries :: !(Maybe [ServiceRegistry]) , _cDeploymentConfiguration :: !(Maybe DeploymentConfiguration) , _cServiceName :: !Text , _cTaskDefinition :: !Text , _cDesiredCount :: !Int } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | 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' - 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' - Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed. -- -- * 'cPlatformVersion' - The platform version on which to run your service. If one is not specified, the latest version is used by default. -- -- * 'cLoadBalancers' - A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here. For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here. -- -- * 'cRole' - The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the @awsvpc@ network mode. If you specify the @role@ parameter, you must also specify a load balancer object with the @loadBalancers@ parameter. /Important:/ If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the @awsvpc@ network mode, in which case you should not specify a role here. For more information, see in the /Amazon Elastic Container Service Developer Guide/ . If your specified role has a path other than @/@ , then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name @bar@ has a path of @/foo/@ then you would specify @/foo/bar@ as the role name. For more information, see in the /IAM User Guide/ . -- -- * 'cPlacementConstraints' - An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time). -- -- * 'cPlacementStrategy' - The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service. -- -- * 'cLaunchType' - The launch type on which to run your service. -- -- * 'cHealthCheckGracePeriodSeconds' - The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800 seconds during which the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up. -- -- * 'cNetworkConfiguration' - The network configuration for the service. This parameter is required for task definitions that use the @awsvpc@ network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see in the /Amazon Elastic Container Service Developer Guide/ . -- -- * 'cServiceRegistries' - The details of the service discovery registries you want to assign to this service. For more information, see . -- -- * 'cDeploymentConfiguration' - Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. -- -- * 'cServiceName' - 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' - The @family@ and @revision@ (@family:revision@ ) or full ARN of the task definition to run in your service. If a @revision@ is not specified, the latest @ACTIVE@ revision is used. -- -- * 'cDesiredCount' - The number of instantiations of the specified task definition to place and keep running on your cluster. createService :: Text -- ^ 'cServiceName' -> Text -- ^ 'cTaskDefinition' -> Int -- ^ 'cDesiredCount' -> CreateService createService pServiceName_ pTaskDefinition_ pDesiredCount_ = CreateService' { _cCluster = Nothing , _cClientToken = Nothing , _cPlatformVersion = Nothing , _cLoadBalancers = Nothing , _cRole = Nothing , _cPlacementConstraints = Nothing , _cPlacementStrategy = Nothing , _cLaunchType = Nothing , _cHealthCheckGracePeriodSeconds = Nothing , _cNetworkConfiguration = Nothing , _cServiceRegistries = Nothing , _cDeploymentConfiguration = Nothing , _cServiceName = pServiceName_ , _cTaskDefinition = pTaskDefinition_ , _cDesiredCount = pDesiredCount_ } -- | 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. cCluster :: Lens' CreateService (Maybe Text) cCluster = lens _cCluster (\ s a -> s{_cCluster = a}) -- | Unique, case-sensitive identifier you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed. cClientToken :: Lens' CreateService (Maybe Text) cClientToken = lens _cClientToken (\ s a -> s{_cClientToken = a}) -- | The platform version on which to run your service. If one is not specified, the latest version is used by default. cPlatformVersion :: Lens' CreateService (Maybe Text) cPlatformVersion = lens _cPlatformVersion (\ s a -> s{_cPlatformVersion = a}) -- | A load balancer object representing the load balancer to use with your service. Currently, you are limited to one load balancer or target group per service. After you create a service, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here. For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here. cLoadBalancers :: Lens' CreateService [LoadBalancer] cLoadBalancers = lens _cLoadBalancers (\ s a -> s{_cLoadBalancers = a}) . _Default . _Coerce -- | The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the @awsvpc@ network mode. If you specify the @role@ parameter, you must also specify a load balancer object with the @loadBalancers@ parameter. /Important:/ If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the @awsvpc@ network mode, in which case you should not specify a role here. For more information, see in the /Amazon Elastic Container Service Developer Guide/ . If your specified role has a path other than @/@ , then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name @bar@ has a path of @/foo/@ then you would specify @/foo/bar@ as the role name. For more information, see in the /IAM User Guide/ . cRole :: Lens' CreateService (Maybe Text) cRole = lens _cRole (\ s a -> s{_cRole = a}) -- | An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time). cPlacementConstraints :: Lens' CreateService [PlacementConstraint] cPlacementConstraints = lens _cPlacementConstraints (\ s a -> s{_cPlacementConstraints = a}) . _Default . _Coerce -- | The placement strategy objects to use for tasks in your service. You can specify a maximum of five strategy rules per service. cPlacementStrategy :: Lens' CreateService [PlacementStrategy] cPlacementStrategy = lens _cPlacementStrategy (\ s a -> s{_cPlacementStrategy = a}) . _Default . _Coerce -- | The launch type on which to run your service. cLaunchType :: Lens' CreateService (Maybe LaunchType) cLaunchType = lens _cLaunchType (\ s a -> s{_cLaunchType = a}) -- | The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 1,800 seconds during which the ECS service scheduler ignores health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up. cHealthCheckGracePeriodSeconds :: Lens' CreateService (Maybe Int) cHealthCheckGracePeriodSeconds = lens _cHealthCheckGracePeriodSeconds (\ s a -> s{_cHealthCheckGracePeriodSeconds = a}) -- | The network configuration for the service. This parameter is required for task definitions that use the @awsvpc@ network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. For more information, see in the /Amazon Elastic Container Service Developer Guide/ . cNetworkConfiguration :: Lens' CreateService (Maybe NetworkConfiguration) cNetworkConfiguration = lens _cNetworkConfiguration (\ s a -> s{_cNetworkConfiguration = a}) -- | The details of the service discovery registries you want to assign to this service. For more information, see . cServiceRegistries :: Lens' CreateService [ServiceRegistry] cServiceRegistries = lens _cServiceRegistries (\ s a -> s{_cServiceRegistries = a}) . _Default . _Coerce -- | Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. cDeploymentConfiguration :: Lens' CreateService (Maybe DeploymentConfiguration) cDeploymentConfiguration = lens _cDeploymentConfiguration (\ s a -> s{_cDeploymentConfiguration = a}) -- | 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. cServiceName :: Lens' CreateService Text cServiceName = lens _cServiceName (\ s a -> s{_cServiceName = a}) -- | The @family@ and @revision@ (@family:revision@ ) or full ARN of the task definition to run in your service. If a @revision@ is not specified, the latest @ACTIVE@ revision is used. cTaskDefinition :: Lens' CreateService Text cTaskDefinition = lens _cTaskDefinition (\ s a -> s{_cTaskDefinition = a}) -- | The number of instantiations of the specified task definition to place and keep running on your cluster. cDesiredCount :: Lens' CreateService Int cDesiredCount = lens _cDesiredCount (\ s a -> s{_cDesiredCount = a}) instance AWSRequest CreateService where type Rs CreateService = CreateServiceResponse request = postJSON ecs response = receiveJSON (\ s h x -> CreateServiceResponse' <$> (x .?> "service") <*> (pure (fromEnum s))) instance Hashable CreateService where instance NFData CreateService where instance ToHeaders CreateService where toHeaders = const (mconcat ["X-Amz-Target" =# ("AmazonEC2ContainerServiceV20141113.CreateService" :: ByteString), "Content-Type" =# ("application/x-amz-json-1.1" :: ByteString)]) instance ToJSON CreateService where toJSON CreateService'{..} = object (catMaybes [("cluster" .=) <$> _cCluster, ("clientToken" .=) <$> _cClientToken, ("platformVersion" .=) <$> _cPlatformVersion, ("loadBalancers" .=) <$> _cLoadBalancers, ("role" .=) <$> _cRole, ("placementConstraints" .=) <$> _cPlacementConstraints, ("placementStrategy" .=) <$> _cPlacementStrategy, ("launchType" .=) <$> _cLaunchType, ("healthCheckGracePeriodSeconds" .=) <$> _cHealthCheckGracePeriodSeconds, ("networkConfiguration" .=) <$> _cNetworkConfiguration, ("serviceRegistries" .=) <$> _cServiceRegistries, ("deploymentConfiguration" .=) <$> _cDeploymentConfiguration, Just ("serviceName" .= _cServiceName), Just ("taskDefinition" .= _cTaskDefinition), Just ("desiredCount" .= _cDesiredCount)]) instance ToPath CreateService where toPath = const "/" instance ToQuery CreateService where toQuery = const mempty -- | /See:/ 'createServiceResponse' smart constructor. data CreateServiceResponse = CreateServiceResponse' { _csrsService :: !(Maybe ContainerService) , _csrsResponseStatus :: !Int } deriving (Eq, Read, Show, Data, Typeable, Generic) -- | 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' - The full description of your service following the create call. -- -- * 'csrsResponseStatus' - -- | The response status code. createServiceResponse :: Int -- ^ 'csrsResponseStatus' -> CreateServiceResponse createServiceResponse pResponseStatus_ = CreateServiceResponse' {_csrsService = Nothing, _csrsResponseStatus = pResponseStatus_} -- | The full description of your service following the create call. csrsService :: Lens' CreateServiceResponse (Maybe ContainerService) csrsService = lens _csrsService (\ s a -> s{_csrsService = a}) -- | -- | The response status code. csrsResponseStatus :: Lens' CreateServiceResponse Int csrsResponseStatus = lens _csrsResponseStatus (\ s a -> s{_csrsResponseStatus = a}) instance NFData CreateServiceResponse where