AwsEcsServiceDetails
Provides details about a service within an ECS cluster.
Contents
- CapacityProviderStrategy
-
The capacity provider strategy that the service uses.
Type: Array of AwsEcsServiceCapacityProviderStrategyDetails objects
Required: No
- Cluster
-
The ARN of the cluster that hosts the service.
Type: String
Pattern:
.*\S.*
Required: No
- DeploymentConfiguration
-
Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.
Type: AwsEcsServiceDeploymentConfigurationDetails object
Required: No
- DeploymentController
-
Contains the deployment controller type that the service uses.
Type: AwsEcsServiceDeploymentControllerDetails object
Required: No
- DesiredCount
-
The number of instantiations of the task definition to run on the service.
Type: Integer
Required: No
- EnableEcsManagedTags
-
Whether to enable Amazon ECS managed tags for the tasks in the service.
Type: Boolean
Required: No
- EnableExecuteCommand
-
Whether the execute command functionality is enabled for the service.
Type: Boolean
Required: No
- HealthCheckGracePeriodSeconds
-
After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.
Type: Integer
Required: No
- LaunchType
-
The launch type that the service uses.
Valid values:
EC2
|FARGATE
|EXTERNAL
Type: String
Pattern:
.*\S.*
Required: No
- LoadBalancers
-
Information about the load balancers that the service uses.
Type: Array of AwsEcsServiceLoadBalancersDetails objects
Required: No
- Name
-
The name of the service.
Type: String
Pattern:
.*\S.*
Required: No
- NetworkConfiguration
-
For tasks that use the
awsvpc
networking mode, the VPC subnet and security group configuration.Type: AwsEcsServiceNetworkConfigurationDetails object
Required: No
- PlacementConstraints
-
The placement constraints for the tasks in the service.
Type: Array of AwsEcsServicePlacementConstraintsDetails objects
Required: No
- PlacementStrategies
-
Information about how tasks for the service are placed.
Type: Array of AwsEcsServicePlacementStrategiesDetails objects
Required: No
- PlatformVersion
-
The platform version on which to run the service. Only specified for tasks that are hosted on AWS Fargate. If a platform version is not specified, the
LATEST
platform version is used by default.Type: String
Pattern:
.*\S.*
Required: No
- PropagateTags
-
Indicates whether to propagate the tags from the task definition to the task or from the service to the task. If no value is provided, then tags are not propagated.
Valid values:
TASK_DEFINITION
|SERVICE
Type: String
Pattern:
.*\S.*
Required: No
- Role
-
The ARN of the IAM role that is associated with the service. The role allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
Type: String
Pattern:
.*\S.*
Required: No
- SchedulingStrategy
-
The scheduling strategy to use for the service.
The
REPLICA
scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions.The
DAEMON
scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that don't meet the placement constraints.Valid values:
REPLICA
|DAEMON
Type: String
Pattern:
.*\S.*
Required: No
- ServiceArn
-
The ARN of the service.
Type: String
Pattern:
.*\S.*
Required: No
- ServiceName
-
The name of the service.
The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.
Type: String
Pattern:
.*\S.*
Required: No
- ServiceRegistries
-
Information about the service discovery registries to assign to the service.
Type: Array of AwsEcsServiceServiceRegistriesDetails objects
Required: No
- TaskDefinition
-
The task definition to use for tasks in the service.
Type: String
Pattern:
.*\S.*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: