Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data ContainerService = ContainerService' {
- capacityProviderStrategy :: Maybe [CapacityProviderStrategyItem]
- clusterArn :: Maybe Text
- createdAt :: Maybe POSIX
- createdBy :: Maybe Text
- deploymentConfiguration :: Maybe DeploymentConfiguration
- deploymentController :: Maybe DeploymentController
- deployments :: Maybe [Deployment]
- desiredCount :: Maybe Int
- enableECSManagedTags :: Maybe Bool
- enableExecuteCommand :: Maybe Bool
- events :: Maybe [ServiceEvent]
- healthCheckGracePeriodSeconds :: Maybe Int
- launchType :: Maybe LaunchType
- loadBalancers :: Maybe [LoadBalancer]
- networkConfiguration :: Maybe NetworkConfiguration
- pendingCount :: Maybe Int
- placementConstraints :: Maybe [PlacementConstraint]
- placementStrategy :: Maybe [PlacementStrategy]
- platformFamily :: Maybe Text
- platformVersion :: Maybe Text
- propagateTags :: Maybe PropagateTags
- roleArn :: Maybe Text
- runningCount :: Maybe Int
- schedulingStrategy :: Maybe SchedulingStrategy
- serviceArn :: Maybe Text
- serviceName :: Maybe Text
- serviceRegistries :: Maybe [ServiceRegistry]
- status :: Maybe Text
- tags :: Maybe [Tag]
- taskDefinition :: Maybe Text
- taskSets :: Maybe [TaskSet]
- newContainerService :: ContainerService
- containerService_capacityProviderStrategy :: Lens' ContainerService (Maybe [CapacityProviderStrategyItem])
- containerService_clusterArn :: Lens' ContainerService (Maybe Text)
- containerService_createdAt :: Lens' ContainerService (Maybe UTCTime)
- containerService_createdBy :: Lens' ContainerService (Maybe Text)
- containerService_deploymentConfiguration :: Lens' ContainerService (Maybe DeploymentConfiguration)
- containerService_deploymentController :: Lens' ContainerService (Maybe DeploymentController)
- containerService_deployments :: Lens' ContainerService (Maybe [Deployment])
- containerService_desiredCount :: Lens' ContainerService (Maybe Int)
- containerService_enableECSManagedTags :: Lens' ContainerService (Maybe Bool)
- containerService_enableExecuteCommand :: Lens' ContainerService (Maybe Bool)
- containerService_events :: Lens' ContainerService (Maybe [ServiceEvent])
- containerService_healthCheckGracePeriodSeconds :: Lens' ContainerService (Maybe Int)
- containerService_launchType :: Lens' ContainerService (Maybe LaunchType)
- containerService_loadBalancers :: Lens' ContainerService (Maybe [LoadBalancer])
- containerService_networkConfiguration :: Lens' ContainerService (Maybe NetworkConfiguration)
- containerService_pendingCount :: Lens' ContainerService (Maybe Int)
- containerService_placementConstraints :: Lens' ContainerService (Maybe [PlacementConstraint])
- containerService_placementStrategy :: Lens' ContainerService (Maybe [PlacementStrategy])
- containerService_platformFamily :: Lens' ContainerService (Maybe Text)
- containerService_platformVersion :: Lens' ContainerService (Maybe Text)
- containerService_propagateTags :: Lens' ContainerService (Maybe PropagateTags)
- containerService_roleArn :: Lens' ContainerService (Maybe Text)
- containerService_runningCount :: Lens' ContainerService (Maybe Int)
- containerService_schedulingStrategy :: Lens' ContainerService (Maybe SchedulingStrategy)
- containerService_serviceArn :: Lens' ContainerService (Maybe Text)
- containerService_serviceName :: Lens' ContainerService (Maybe Text)
- containerService_serviceRegistries :: Lens' ContainerService (Maybe [ServiceRegistry])
- containerService_status :: Lens' ContainerService (Maybe Text)
- containerService_tags :: Lens' ContainerService (Maybe [Tag])
- containerService_taskDefinition :: Lens' ContainerService (Maybe Text)
- containerService_taskSets :: Lens' ContainerService (Maybe [TaskSet])
Documentation
data ContainerService Source #
Details on a service within a cluster
See: newContainerService
smart constructor.
ContainerService' | |
|
Instances
newContainerService :: ContainerService Source #
Create a value of ContainerService
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ContainerService
, containerService_capacityProviderStrategy
- The capacity provider strategy the service uses. When using the
DescribeServices API, this field is omitted if the service was created
using a launch type.
ContainerService
, containerService_clusterArn
- The Amazon Resource Name (ARN) of the cluster that hosts the service.
ContainerService
, containerService_createdAt
- The Unix timestamp for the time when the service was created.
$sel:createdBy:ContainerService'
, containerService_createdBy
- The principal that created the service.
$sel:deploymentConfiguration:ContainerService'
, containerService_deploymentConfiguration
- Optional deployment parameters that control how many tasks run during
the deployment and the ordering of stopping and starting tasks.
$sel:deploymentController:ContainerService'
, containerService_deploymentController
- The deployment controller type the service is using.
$sel:deployments:ContainerService'
, containerService_deployments
- The current state of deployments for the service.
ContainerService
, containerService_desiredCount
- The desired number of instantiations of the task definition to keep
running on the service. This value is specified when the service is
created with CreateService, and it can be modified with UpdateService.
$sel:enableECSManagedTags:ContainerService'
, containerService_enableECSManagedTags
- Determines whether to use Amazon ECS managed tags for the tasks in the
service. For more information, see
Tagging Your Amazon ECS Resources
in the Amazon Elastic Container Service Developer Guide.
$sel:enableExecuteCommand:ContainerService'
, containerService_enableExecuteCommand
- Determines whether the execute command functionality is enabled for the
service. If true
, the execute command functionality is enabled for all
containers in tasks as part of the service.
$sel:events:ContainerService'
, containerService_events
- The event stream for your service. A maximum of 100 of the latest events
are displayed.
$sel:healthCheckGracePeriodSeconds:ContainerService'
, containerService_healthCheckGracePeriodSeconds
- The period of time, in seconds, that the Amazon ECS service scheduler
ignores unhealthy Elastic Load Balancing target health checks after a
task has first started.
ContainerService
, containerService_launchType
- The launch type the service is using. When using the DescribeServices
API, this field is omitted if the service was created using a capacity
provider strategy.
ContainerService
, containerService_loadBalancers
- A list of Elastic Load Balancing load balancer objects. It contains the
load balancer name, the container name, and the container port to access
from the load balancer. The container name is as it appears in a
container definition.
ContainerService
, containerService_networkConfiguration
- The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc
networking
mode.
ContainerService
, containerService_pendingCount
- The number of tasks in the cluster that are in the PENDING
state.
$sel:placementConstraints:ContainerService'
, containerService_placementConstraints
- The placement constraints for the tasks in the service.
$sel:placementStrategy:ContainerService'
, containerService_placementStrategy
- The placement strategy that determines how tasks for the service are
placed.
ContainerService
, containerService_platformFamily
- The operating system that your tasks in the service run on. A platform
family is specified only for tasks using the Fargate launch type.
All tasks that run as part of this service must use the same
platformFamily
value as the service (for example, LINUX
).
ContainerService
, containerService_platformVersion
- The platform version to run your service on. A platform version is only
specified for tasks that are hosted on Fargate. If one isn't specified,
the LATEST
platform version is used. For more information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
$sel:propagateTags:ContainerService'
, containerService_propagateTags
- Determines whether to propagate the tags from the task definition or the
service to the task. If no value is specified, the tags aren't
propagated.
$sel:roleArn:ContainerService'
, containerService_roleArn
- The ARN of the IAM role that's associated with the service. It allows
the Amazon ECS container agent to register container instances with an
Elastic Load Balancing load balancer.
ContainerService
, containerService_runningCount
- The number of tasks in the cluster that are in the RUNNING
state.
$sel:schedulingStrategy:ContainerService'
, containerService_schedulingStrategy
- The scheduling strategy to use for the service. For more information,
see
Services.
There are two service scheduler strategies available.
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.DAEMON
-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.Fargate tasks don't support the
DAEMON
scheduling strategy.
ContainerService
, containerService_serviceArn
- The ARN that identifies the service. For more information about the ARN
format, see
Amazon Resource Name (ARN)
in the Amazon ECS Developer Guide.
$sel:serviceName:ContainerService'
, containerService_serviceName
- The name of your service. Up to 255 letters (uppercase and lowercase),
numbers, underscores, and hyphens are allowed. Service names must be
unique within a cluster. However, you can have similarly named services
in multiple clusters within a Region or across multiple Regions.
ContainerService
, containerService_serviceRegistries
- The details for the service discovery registries to assign to this
service. For more information, see
Service Discovery.
ContainerService
, containerService_status
- The status of the service. The valid values are ACTIVE
, DRAINING
, or
INACTIVE
.
ContainerService
, containerService_tags
- The metadata that you apply to the service to help you categorize and
organize them. Each tag consists of a key and an optional value. You
define bot the key and value.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
ContainerService
, containerService_taskDefinition
- The task definition to use for tasks in the service. This value is
specified when the service is created with CreateService, and it can be
modified with UpdateService.
$sel:taskSets:ContainerService'
, containerService_taskSets
- Information about a set of Amazon ECS tasks in either an CodeDeploy or
an EXTERNAL
deployment. An Amazon ECS task set includes details such
as the desired number of tasks, how many tasks are running, and whether
the task set serves production traffic.
containerService_capacityProviderStrategy :: Lens' ContainerService (Maybe [CapacityProviderStrategyItem]) Source #
The capacity provider strategy the service uses. When using the DescribeServices API, this field is omitted if the service was created using a launch type.
containerService_clusterArn :: Lens' ContainerService (Maybe Text) Source #
The Amazon Resource Name (ARN) of the cluster that hosts the service.
containerService_createdAt :: Lens' ContainerService (Maybe UTCTime) Source #
The Unix timestamp for the time when the service was created.
containerService_createdBy :: Lens' ContainerService (Maybe Text) Source #
The principal that created the service.
containerService_deploymentConfiguration :: Lens' ContainerService (Maybe DeploymentConfiguration) Source #
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
containerService_deploymentController :: Lens' ContainerService (Maybe DeploymentController) Source #
The deployment controller type the service is using.
containerService_deployments :: Lens' ContainerService (Maybe [Deployment]) Source #
The current state of deployments for the service.
containerService_desiredCount :: Lens' ContainerService (Maybe Int) Source #
The desired number of instantiations of the task definition to keep running on the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
containerService_enableECSManagedTags :: Lens' ContainerService (Maybe Bool) Source #
Determines whether to use Amazon ECS managed tags for the tasks in the service. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
containerService_enableExecuteCommand :: Lens' ContainerService (Maybe Bool) Source #
Determines whether the execute command functionality is enabled for the
service. If true
, the execute command functionality is enabled for all
containers in tasks as part of the service.
containerService_events :: Lens' ContainerService (Maybe [ServiceEvent]) Source #
The event stream for your service. A maximum of 100 of the latest events are displayed.
containerService_healthCheckGracePeriodSeconds :: Lens' ContainerService (Maybe Int) Source #
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
containerService_launchType :: Lens' ContainerService (Maybe LaunchType) Source #
The launch type the service is using. When using the DescribeServices API, this field is omitted if the service was created using a capacity provider strategy.
containerService_loadBalancers :: Lens' ContainerService (Maybe [LoadBalancer]) Source #
A list of Elastic Load Balancing load balancer objects. It contains the load balancer name, the container name, and the container port to access from the load balancer. The container name is as it appears in a container definition.
containerService_networkConfiguration :: Lens' ContainerService (Maybe NetworkConfiguration) Source #
The VPC subnet and security group configuration for tasks that receive
their own elastic network interface by using the awsvpc
networking
mode.
containerService_pendingCount :: Lens' ContainerService (Maybe Int) Source #
The number of tasks in the cluster that are in the PENDING
state.
containerService_placementConstraints :: Lens' ContainerService (Maybe [PlacementConstraint]) Source #
The placement constraints for the tasks in the service.
containerService_placementStrategy :: Lens' ContainerService (Maybe [PlacementStrategy]) Source #
The placement strategy that determines how tasks for the service are placed.
containerService_platformFamily :: Lens' ContainerService (Maybe Text) Source #
The operating system that your tasks in the service run on. A platform family is specified only for tasks using the Fargate launch type.
All tasks that run as part of this service must use the same
platformFamily
value as the service (for example, LINUX
).
containerService_platformVersion :: Lens' ContainerService (Maybe Text) Source #
The platform version to run your service on. A platform version is only
specified for tasks that are hosted on Fargate. If one isn't specified,
the LATEST
platform version is used. For more information, see
Fargate Platform Versions
in the Amazon Elastic Container Service Developer Guide.
containerService_propagateTags :: Lens' ContainerService (Maybe PropagateTags) Source #
Determines whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
containerService_roleArn :: Lens' ContainerService (Maybe Text) Source #
The ARN of the IAM role that's associated with the service. It allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
containerService_runningCount :: Lens' ContainerService (Maybe Int) Source #
The number of tasks in the cluster that are in the RUNNING
state.
containerService_schedulingStrategy :: Lens' ContainerService (Maybe SchedulingStrategy) Source #
The scheduling strategy to use for the service. For more information, see Services.
There are two service scheduler strategies available.
REPLICA
-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions.DAEMON
-The daemon scheduling strategy deploys exactly one task on each active container instance. This task meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks. It stop tasks that don't meet the placement constraints.Fargate tasks don't support the
DAEMON
scheduling strategy.
containerService_serviceArn :: Lens' ContainerService (Maybe Text) Source #
The ARN that identifies the service. For more information about the ARN format, see Amazon Resource Name (ARN) in the Amazon ECS Developer Guide.
containerService_serviceName :: Lens' ContainerService (Maybe Text) Source #
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster. However, you can have similarly named services in multiple clusters within a Region or across multiple Regions.
containerService_serviceRegistries :: Lens' ContainerService (Maybe [ServiceRegistry]) Source #
The details for the service discovery registries to assign to this service. For more information, see Service Discovery.
containerService_status :: Lens' ContainerService (Maybe Text) Source #
The status of the service. The valid values are ACTIVE
, DRAINING
, or
INACTIVE
.
containerService_tags :: Lens' ContainerService (Maybe [Tag]) Source #
The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value. You define bot the key and value.
The following basic restrictions apply to tags:
- Maximum number of tags per resource - 50
- For each resource, each tag key must be unique, and each tag key can have only one value.
- Maximum key length - 128 Unicode characters in UTF-8
- Maximum value length - 256 Unicode characters in UTF-8
- If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
- Tag keys and values are case-sensitive.
- Do not use
aws:
,AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
containerService_taskDefinition :: Lens' ContainerService (Maybe Text) Source #
The task definition to use for tasks in the service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
containerService_taskSets :: Lens' ContainerService (Maybe [TaskSet]) Source #
Information about a set of Amazon ECS tasks in either an CodeDeploy or
an EXTERNAL
deployment. An Amazon ECS task set includes details such
as the desired number of tasks, how many tasks are running, and whether
the task set serves production traffic.