Skip to main content

services

Creates, updates, deletes or gets a service resource or lists services in a region

Overview​

Nameservices
TypeResource
DescriptionThe AWS::ECS::Service resource creates an Amazon Elastic Container Service (Amazon ECS) service that runs and maintains the requested number of tasks and associated load balancers.
The stack update fails if you change any properties that require replacement and at least one ECS Service Connect ServiceConnectConfiguration property the is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceConnectService must have a name that is unique in the namespace.
Starting April 15, 2023, AWS; will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, ECS, or EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
Idaws.ecs.services

Fields​

NameDatatypeDescription
platform_versionstringThe platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.
propagate_tagsstringSpecifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action.
You must set this to a value other than NONE when you use Cost Explorer. For more information, see [Amazon ECS usage reports](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/usage-reports.html) in the *Amazon Elastic Container Service Developer Guide*.
The default is NONE.
service_arnstring
placement_strategiesarrayThe placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
service_registriesarrayThe details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).
Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
volume_configurationsarrayThe configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.
capacity_provider_strategyarrayThe capacity provider strategy to use for the service.
If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
A capacity provider strategy can contain a maximum of 20 capacity providers.
launch_typestringThe launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.
namestring
availability_zone_rebalancingstringIndicates whether to use Availability Zone rebalancing for the service.
For more information, see [Balancing an Amazon ECS service across Availability Zones](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html) in the *Amazon Elastic Container Service Developer Guide*.
scheduling_strategystringThe scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html).
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. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.
+ DAEMON-The daemon scheduling strategy deploys exactly one task on each active container instance that 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 and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
network_configurationobjectThe 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 [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
tagsarrayThe metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
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 AWS 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.
health_check_grace_period_secondsintegerThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of 0 is used. If you don't use any of the health checks, then healthCheckGracePeriodSeconds is unused.
If your service's tasks take a while to start and respond to health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
enable_ecs_managed_tagsbooleanSpecifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*.
When you use Amazon ECS managed tags, you need to set the propagateTags request parameter.
enable_execute_commandbooleanDetermines whether the execute command functionality is turned on for the service. If true, the execute command functionality is turned on for all containers in tasks as part of the service.
placement_constraintsarrayAn array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
clusterstringThe short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.
load_balancersarrayA list of load balancer objects to associate with the service. If you specify the Role property, LoadBalancers must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*.
service_connect_configurationobjectThe configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.
desired_countintegerThe number of instantiations of the specified task definition to place and keep running in your service.
For new services, if a desired count is not specified, a default value of 1 is used. When using the DAEMON scheduling strategy, the desired count is not required.
For existing services, if a desired count is not specified, it is omitted from the operation.
vpc_lattice_configurationsarrayThe VPC Lattice configuration for the service being created.
deployment_controllerobjectThe deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.
rolestringThe 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 doesn't use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.
If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) 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 [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*.
task_definitionstringThe family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn't specified, the latest ACTIVE revision is used.
A task definition must be specified if the service uses either the ECS or CODE_DEPLOY deployment controllers.
For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html).
service_namestringThe 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, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
The stack update fails if you change any properties that require replacement and the ServiceName is configured. This is because AWS CloudFormation creates the replacement service first, but each ServiceName must be unique in the cluster.
deployment_configurationobjectOptional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
regionstringAWS region.

For more information, see AWS::ECS::Service.

Methods​

NameAccessible byRequired Params
create_resourceINSERTregion
delete_resourceDELETEdata__Identifier, region
update_resourceUPDATEdata__Identifier, data__PatchDocument, region
list_resourcesSELECTregion
get_resourceSELECTdata__Identifier, region

SELECT examples​

Gets all services in a region.

SELECT
region,
platform_version,
propagate_tags,
service_arn,
placement_strategies,
service_registries,
volume_configurations,
capacity_provider_strategy,
launch_type,
name,
availability_zone_rebalancing,
scheduling_strategy,
network_configuration,
tags,
health_check_grace_period_seconds,
enable_ecs_managed_tags,
enable_execute_command,
placement_constraints,
cluster,
load_balancers,
service_connect_configuration,
desired_count,
vpc_lattice_configurations,
deployment_controller,
role,
task_definition,
service_name,
deployment_configuration
FROM aws.ecs.services
WHERE region = 'us-east-1';

Gets all properties from an individual service.

SELECT
region,
platform_version,
propagate_tags,
service_arn,
placement_strategies,
service_registries,
volume_configurations,
capacity_provider_strategy,
launch_type,
name,
availability_zone_rebalancing,
scheduling_strategy,
network_configuration,
tags,
health_check_grace_period_seconds,
enable_ecs_managed_tags,
enable_execute_command,
placement_constraints,
cluster,
load_balancers,
service_connect_configuration,
desired_count,
vpc_lattice_configurations,
deployment_controller,
role,
task_definition,
service_name,
deployment_configuration
FROM aws.ecs.services
WHERE region = 'us-east-1' AND data__Identifier = '<ServiceArn>|<Cluster>';

INSERT example​

Use the following StackQL query and manifest file to create a new service resource, using stack-deploy.

/*+ create */
INSERT INTO aws.ecs.services (
 PlatformVersion,
 PropagateTags,
 PlacementStrategies,
 ServiceRegistries,
 VolumeConfigurations,
 CapacityProviderStrategy,
 LaunchType,
 AvailabilityZoneRebalancing,
 SchedulingStrategy,
 NetworkConfiguration,
 Tags,
 HealthCheckGracePeriodSeconds,
 EnableECSManagedTags,
 EnableExecuteCommand,
 PlacementConstraints,
 Cluster,
 LoadBalancers,
 ServiceConnectConfiguration,
 DesiredCount,
 VpcLatticeConfigurations,
 DeploymentController,
 Role,
 TaskDefinition,
 ServiceName,
 DeploymentConfiguration,
 region
)
SELECT 
'{{ PlatformVersion }}',
 '{{ PropagateTags }}',
 '{{ PlacementStrategies }}',
 '{{ ServiceRegistries }}',
 '{{ VolumeConfigurations }}',
 '{{ CapacityProviderStrategy }}',
 '{{ LaunchType }}',
 '{{ AvailabilityZoneRebalancing }}',
 '{{ SchedulingStrategy }}',
 '{{ NetworkConfiguration }}',
 '{{ Tags }}',
 '{{ HealthCheckGracePeriodSeconds }}',
 '{{ EnableECSManagedTags }}',
 '{{ EnableExecuteCommand }}',
 '{{ PlacementConstraints }}',
 '{{ Cluster }}',
 '{{ LoadBalancers }}',
 '{{ ServiceConnectConfiguration }}',
 '{{ DesiredCount }}',
 '{{ VpcLatticeConfigurations }}',
 '{{ DeploymentController }}',
 '{{ Role }}',
 '{{ TaskDefinition }}',
 '{{ ServiceName }}',
 '{{ DeploymentConfiguration }}',
'{{ region }}';

DELETE example​

/*+ delete */
DELETE FROM aws.ecs.services
WHERE data__Identifier = '<ServiceArn|Cluster>'
AND region = 'us-east-1';

Permissions​

To operate on the services resource, the following permissions are required:

Read​

ecs:DescribeServices

Create​

ecs:CreateService,
ecs:DescribeServices,
iam:PassRole,
ecs:TagResource

Update​

ecs:DescribeServices,
ecs:ListTagsForResource,
ecs:TagResource,
ecs:UntagResource,
ecs:UpdateService

List​

ecs:DescribeServices,
ecs:ListClusters,
ecs:ListServices

Delete​

ecs:DeleteService,
ecs:DescribeServices