@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
195 lines (194 loc) • 20.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* The ``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 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.
* On June 12, 2025, Amazon ECS launched support for updating capacity provider configuration for ECS services. With this launch, ECS also aligned the CFN update behavior for ``CapacityProviderStrategy`` parameter with the standard practice. For more information, see [adds support for updating capacity provider configuration for ECS services](https://docs.aws.amazon.com/about-aws/whats-new/2025/05/amazon-ecs-capacity-provider-configuration-ecs/). Previously ECS ignored the ``CapacityProviderStrategy`` property if it was set to an empty list for example, ``[]`` in CFN, because updating capacity provider configuration was not supported. Now, with support for capacity provider updates, customers can remove capacity providers from a service by passing an empty list. When you specify an empty list (``[]``) for the ``CapacityProviderStrategy`` property in your CFN template, ECS will remove any capacity providers associated with the service, as follows:
* + For services created with a capacity provider strategy after the launch:
* + If there's a cluster default strategy set, the service will revert to using that default strategy.
* + If no cluster default strategy exists, you will receive the following error:
* No launch type to fall back to for empty capacity provider strategy. Your service was not created with a launch type.
*
* + For services created with a capacity provider strategy prior to the launch:
* + If ``CapacityProviderStrategy`` had ``FARGATE_SPOT`` or ``FARGATE`` capacity providers, the launch type will be updated to ``FARGATE`` and the capacity provider will be removed.
* + If the strategy included Auto Scaling group capacity providers, the service will revert to EC2 launch type, and the Auto Scaling group capacity providers will not be used.
*
* Recommended Actions
* If you are currently using ``CapacityProviderStrategy: []`` in your CFN templates, you should take one of the following actions:
* + If you do not intend to update the Capacity Provider Strategy:
* + Remove the ``CapacityProviderStrategy`` property entirely from your CFN template
* + Alternatively, use ``!Ref ::NoValue`` for the ``CapacityProviderStrategy`` property in your template
*
* + If you intend to maintain or update the Capacity Provider Strategy, specify the actual Capacity Provider Strategy for the service in your CFN template.
*
* If your CFN template had an empty list ([]) for ``CapacityProviderStrategy`` prior to the aforementioned launch on June 12, and you are using the same template with ``CapacityProviderStrategy: []``, you might encounter the following error:
* Invalid request provided: When switching from launch type to capacity provider strategy on an existing service, or making a change to a capacity provider strategy on a service that is already using one, you must force a new deployment. (Service: Ecs, Status Code: 400, Request ID: xxx) (SDK Attempt Count: 1)" (RequestToken: xxx HandlerErrorCode: InvalidRequest)
* Note that CFN automatically initiates a new deployment when it detects a parameter change, but customers cannot choose to force a deployment through CFN. This is an invalid input scenario that requires one of the remediation actions listed above.
* If you are experiencing active production issues related to this change, contact AWS Support or your Technical Account Manager.
*/
export declare function getService(args: GetServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceResult>;
export interface GetServiceArgs {
/**
* The 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.
*/
cluster: string;
/**
* The ARN that identifies the service. For more information about the ARN format, see [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) in the *Amazon ECS Developer Guide* .
*/
serviceArn: string;
}
export interface GetServiceResult {
/**
* Indicates 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*.
* The default behavior of ``AvailabilityZoneRebalancing`` differs between create and update requests:
* + For create service requests, when no value is specified for ``AvailabilityZoneRebalancing``, Amazon ECS defaults the value to ``ENABLED``.
* + For update service requests, when no value is specified for ``AvailabilityZoneRebalancing``, Amazon ECS defaults to the existing service’s ``AvailabilityZoneRebalancing`` value. If the service never had an ``AvailabilityZoneRebalancing`` value set, Amazon ECS treats this as ``DISABLED``.
*/
readonly availabilityZoneRebalancing?: enums.ecs.ServiceAvailabilityZoneRebalancing;
/**
* The 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.
* To remove this property from your service resource, specify an empty ``CapacityProviderStrategyItem`` array.
*/
readonly capacityProviderStrategy?: outputs.ecs.ServiceCapacityProviderStrategyItem[];
/**
* Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
*/
readonly deploymentConfiguration?: outputs.ecs.ServiceDeploymentConfiguration;
/**
* The deployment controller to use for the service.
*/
readonly deploymentController?: outputs.ecs.ServiceDeploymentController;
/**
* The 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.
*/
readonly desiredCount?: number;
/**
* Specifies 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 must set the ``propagateTags`` request parameter.
*/
readonly enableEcsManagedTags?: boolean;
/**
* Determines 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.
*/
readonly enableExecuteCommand?: boolean;
/**
* The 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 do not specify a health check grace period value, the default value of 0 is used. If you do not use any of the health checks, then ``healthCheckGracePeriodSeconds`` is unused.
* If your service has more running tasks than desired, unhealthy tasks in the grace period might be stopped to reach the desired count.
*/
readonly healthCheckGracePeriodSeconds?: number;
/**
* The 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*.
* If you want to use Managed Instances, you must use the ``capacityProviderStrategy`` request parameter
*/
readonly launchType?: enums.ecs.ServiceLaunchType;
/**
* A 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*.
* To remove this property from your service resource, specify an empty ``LoadBalancer`` array.
*/
readonly loadBalancers?: outputs.ecs.ServiceLoadBalancer[];
/**
* The name of the Amazon ECS service, such as `sample-webapp` .
*/
readonly name?: string;
/**
* 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 [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*.
*/
readonly networkConfiguration?: outputs.ecs.ServiceNetworkConfiguration;
/**
* An 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.
* To remove this property from your service resource, specify an empty ``PlacementConstraint`` array.
*/
readonly placementConstraints?: outputs.ecs.ServicePlacementConstraint[];
/**
* The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.
* To remove this property from your service resource, specify an empty ``PlacementStrategy`` array.
*/
readonly placementStrategies?: outputs.ecs.ServicePlacementStrategy[];
/**
* The 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*.
*/
readonly platformVersion?: string;
/**
* Specifies 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``.
*/
readonly propagateTags?: enums.ecs.ServicePropagateTags;
/**
* The ARN that identifies the service. For more information about the ARN format, see [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) in the *Amazon ECS Developer Guide* .
*/
readonly serviceArn?: string;
/**
* The 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.
* To remove this property from your service resource, specify an empty ``ServiceRegistry`` array.
*/
readonly serviceRegistries?: outputs.ecs.ServiceRegistry[];
/**
* 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, 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.
*/
readonly tags?: outputs.Tag[];
/**
* The ``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).
*/
readonly taskDefinition?: string;
/**
* The VPC Lattice configuration for the service being created.
*/
readonly vpcLatticeConfigurations?: outputs.ecs.ServiceVpcLatticeConfiguration[];
}
/**
* The ``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 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.
* On June 12, 2025, Amazon ECS launched support for updating capacity provider configuration for ECS services. With this launch, ECS also aligned the CFN update behavior for ``CapacityProviderStrategy`` parameter with the standard practice. For more information, see [adds support for updating capacity provider configuration for ECS services](https://docs.aws.amazon.com/about-aws/whats-new/2025/05/amazon-ecs-capacity-provider-configuration-ecs/). Previously ECS ignored the ``CapacityProviderStrategy`` property if it was set to an empty list for example, ``[]`` in CFN, because updating capacity provider configuration was not supported. Now, with support for capacity provider updates, customers can remove capacity providers from a service by passing an empty list. When you specify an empty list (``[]``) for the ``CapacityProviderStrategy`` property in your CFN template, ECS will remove any capacity providers associated with the service, as follows:
* + For services created with a capacity provider strategy after the launch:
* + If there's a cluster default strategy set, the service will revert to using that default strategy.
* + If no cluster default strategy exists, you will receive the following error:
* No launch type to fall back to for empty capacity provider strategy. Your service was not created with a launch type.
*
* + For services created with a capacity provider strategy prior to the launch:
* + If ``CapacityProviderStrategy`` had ``FARGATE_SPOT`` or ``FARGATE`` capacity providers, the launch type will be updated to ``FARGATE`` and the capacity provider will be removed.
* + If the strategy included Auto Scaling group capacity providers, the service will revert to EC2 launch type, and the Auto Scaling group capacity providers will not be used.
*
* Recommended Actions
* If you are currently using ``CapacityProviderStrategy: []`` in your CFN templates, you should take one of the following actions:
* + If you do not intend to update the Capacity Provider Strategy:
* + Remove the ``CapacityProviderStrategy`` property entirely from your CFN template
* + Alternatively, use ``!Ref ::NoValue`` for the ``CapacityProviderStrategy`` property in your template
*
* + If you intend to maintain or update the Capacity Provider Strategy, specify the actual Capacity Provider Strategy for the service in your CFN template.
*
* If your CFN template had an empty list ([]) for ``CapacityProviderStrategy`` prior to the aforementioned launch on June 12, and you are using the same template with ``CapacityProviderStrategy: []``, you might encounter the following error:
* Invalid request provided: When switching from launch type to capacity provider strategy on an existing service, or making a change to a capacity provider strategy on a service that is already using one, you must force a new deployment. (Service: Ecs, Status Code: 400, Request ID: xxx) (SDK Attempt Count: 1)" (RequestToken: xxx HandlerErrorCode: InvalidRequest)
* Note that CFN automatically initiates a new deployment when it detects a parameter change, but customers cannot choose to force a deployment through CFN. This is an invalid input scenario that requires one of the remediation actions listed above.
* If you are experiencing active production issues related to this change, contact AWS Support or your Technical Account Manager.
*/
export declare function getServiceOutput(args: GetServiceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetServiceResult>;
export interface GetServiceOutputArgs {
/**
* The 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.
*/
cluster: pulumi.Input<string>;
/**
* The ARN that identifies the service. For more information about the ARN format, see [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids) in the *Amazon ECS Developer Guide* .
*/
serviceArn: pulumi.Input<string>;
}