Service class

Details on a service within a cluster

Constructors

Service({List<CapacityProviderStrategyItem>? capacityProviderStrategy, String? clusterArn, DateTime? createdAt, String? createdBy, DeploymentConfiguration? deploymentConfiguration, DeploymentController? deploymentController, List<Deployment>? deployments, int? desiredCount, bool? enableECSManagedTags, List<ServiceEvent>? events, int? healthCheckGracePeriodSeconds, LaunchType? launchType, List<LoadBalancer>? loadBalancers, NetworkConfiguration? networkConfiguration, int? pendingCount, List<PlacementConstraint>? placementConstraints, List<PlacementStrategy>? placementStrategy, String? platformVersion, PropagateTags? propagateTags, String? roleArn, int? runningCount, SchedulingStrategy? schedulingStrategy, String? serviceArn, String? serviceName, List<ServiceRegistry>? serviceRegistries, String? status, List<Tag>? tags, String? taskDefinition, List<TaskSet>? taskSets})
Service.fromJson(Map<String, dynamic> json)
factory

Properties

capacityProviderStrategy → List<CapacityProviderStrategyItem>?
The capacity provider strategy associated with the service.
final
clusterArn → String?
The Amazon Resource Name (ARN) of the cluster that hosts the service.
final
createdAt → DateTime?
The Unix timestamp for when the service was created.
final
createdBy → String?
The principal that created the service.
final
deploymentConfiguration → DeploymentConfiguration?
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
final
deploymentController → DeploymentController?
The deployment controller type the service is using. When using the DescribeServices API, this field is omitted if the service is using the ECS deployment controller type.
final
deployments → List<Deployment>?
The current state of deployments for the service.
final
desiredCount → int?
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.
final
enableECSManagedTags → bool?
Specifies whether to enable 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.
final
events → List<ServiceEvent>?
The event stream for your service. A maximum of 100 of the latest events are displayed.
final
hashCode → int
The hash code for this object.
no setterinherited
healthCheckGracePeriodSeconds → int?
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.
final
launchType → LaunchType?
The launch type on which your service is running. If no value is specified, it will default to EC2. Valid values include EC2 and FARGATE. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
final
loadBalancers → List<LoadBalancer>?
A list of Elastic Load Balancing 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.
final
networkConfiguration → NetworkConfiguration?
The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.
final
pendingCount → int?
The number of tasks in the cluster that are in the PENDING state.
final
placementConstraints → List<PlacementConstraint>?
The placement constraints for the tasks in the service.
final
placementStrategy → List<PlacementStrategy>?
The placement strategy that determines how tasks for the service are placed.
final
platformVersion → String?
The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
final
propagateTags → PropagateTags?
Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.
final
roleArn → String?
The ARN of the IAM role associated with the service that allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
final
runningCount → int?
The number of tasks in the cluster that are in the RUNNING state.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schedulingStrategy → SchedulingStrategy?
The scheduling strategy to use for the service. For more information, see Services.
final
serviceArn → String?
The ARN that identifies the service. The ARN contains the arn:aws:ecs namespace, followed by the Region of the service, the AWS account ID of the service owner, the service namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service.
final
serviceName → String?
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, 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.
final
serviceRegistries → List<ServiceRegistry>?
The details of the service discovery registries to assign to this service. For more information, see Service Discovery.
final
status → String?
The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE.
final
tags → List<Tag>?
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.
final
taskDefinition → String?
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.
final
taskSets → List<TaskSet>?
Information about a set of Amazon ECS tasks in either an AWS 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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited