interface ExternalServiceProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.ECS.ExternalServiceProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsecs#ExternalServiceProps |
Java | software.amazon.awscdk.services.ecs.ExternalServiceProps |
Python | aws_cdk.aws_ecs.ExternalServiceProps |
TypeScript (source) | aws-cdk-lib » aws_ecs » ExternalServiceProps |
The properties for defining a service using the External launch type.
Example
declare const cluster: ecs.Cluster;
declare const taskDefinition: ecs.TaskDefinition;
const service = new ecs.ExternalService(this, 'Service', {
cluster,
taskDefinition,
desiredCount: 5,
});
Properties
Name | Type | Description |
---|---|---|
cluster | ICluster | The name of the cluster that hosts the service. |
task | Task | The task definition to use for tasks in the service. |
capacity | Capacity [] | A list of Capacity Provider strategies used to place a service. |
circuit | Deployment | Whether to enable the deployment circuit breaker. |
cloud | Cloud | The options for configuring an Amazon ECS service to use service discovery. |
deployment | Deployment | The alarm(s) to monitor during deployment, and behavior to apply if at least one enters a state of alarm during the deployment or bake time. |
deployment | Deployment | Specifies which deployment controller to use for the service. |
desired | number | The desired number of instantiations of the task definition to keep running on the service. |
enable | boolean | Specifies whether to enable Amazon ECS managed tags for the tasks within the service. |
enable | boolean | Whether to enable the ability to execute into a container. |
health | Duration | 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. |
max | number | The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment. |
min | number | The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment. |
propagate | Propagated | Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. |
security | ISecurity [] | The security groups to associate with the service. |
service | Service | Configuration for Service Connect. |
service | string | The name of the service. |
task | Task | Revision number for the task definition or latest to use the latest active task revision. |
volume | Service [] | Configuration details for a volume used by the service. |
cluster
Type:
ICluster
The name of the cluster that hosts the service.
taskDefinition
Type:
Task
The task definition to use for tasks in the service.
[disable-awslint:ref-via-interface]
capacityProviderStrategies?
Type:
Capacity
[]
(optional, default: undefined)
A list of Capacity Provider strategies used to place a service.
circuitBreaker?
Type:
Deployment
(optional, default: disabled)
Whether to enable the deployment circuit breaker.
If this property is defined, circuit breaker will be implicitly enabled.
cloudMapOptions?
Type:
Cloud
(optional, default: AWS Cloud Map service discovery is not enabled.)
The options for configuring an Amazon ECS service to use service discovery.
deploymentAlarms?
Type:
Deployment
(optional, default: No alarms will be monitored during deployment.)
The alarm(s) to monitor during deployment, and behavior to apply if at least one enters a state of alarm during the deployment or bake time.
deploymentController?
Type:
Deployment
(optional, default: Rolling update (ECS))
Specifies which deployment controller to use for the service.
For more information, see Amazon ECS Deployment Types
desiredCount?
Type:
number
(optional, default: When creating the service, default is 1; when updating the service, default uses
the current task number.)
The desired number of instantiations of the task definition to keep running on the service.
enableECSManagedTags?
Type:
boolean
(optional, default: false)
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
For more information, see Tagging Your Amazon ECS Resources
enableExecuteCommand?
Type:
boolean
(optional, default: undefined)
Whether to enable the ability to execute into a container.
healthCheckGracePeriod?
Type:
Duration
(optional, default: defaults to 60 seconds if at least one load balancer is in-use and it is not already set)
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.
maxHealthyPercent?
Type:
number
(optional, default: 100 if daemon, otherwise 200)
The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
minHealthyPercent?
Type:
number
(optional, default: 0 if daemon, otherwise 50)
The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
propagateTags?
Type:
Propagated
(optional, default: PropagatedTagSource.NONE)
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or PropagatedTagSource.NONE
securityGroups?
Type:
ISecurity
[]
(optional, default: A new security group is created.)
The security groups to associate with the service.
If you do not specify a security group, a new security group is created.
serviceConnectConfiguration?
Type:
Service
(optional, default: No ports are advertised via Service Connect on this service, and the service
cannot make requests to other services via Service Connect.)
Configuration for Service Connect.
serviceName?
Type:
string
(optional, default: CloudFormation-generated name.)
The name of the service.
taskDefinitionRevision?
Type:
Task
(optional, default: Uses the revision of the passed task definition deployed by CloudFormation)
Revision number for the task definition or latest
to use the latest active task revision.
volumeConfigurations?
Type:
Service
[]
(optional, default: undefined)
Configuration details for a volume used by the service.
This allows you to specify details about the EBS volume that can be attched to ECS tasks.