Ec2ServiceProps

class aws_cdk.aws_ecs.Ec2ServiceProps(*, cluster, capacity_provider_strategies=None, circuit_breaker=None, cloud_map_options=None, deployment_controller=None, desired_count=None, enable_ecs_managed_tags=None, enable_execute_command=None, health_check_grace_period=None, max_healthy_percent=None, min_healthy_percent=None, propagate_tags=None, propagate_task_tags_from=None, service_name=None, task_definition, assign_public_ip=None, daemon=None, placement_constraints=None, placement_strategies=None, security_group=None, security_groups=None, vpc_subnets=None)

Bases: BaseServiceOptions

The properties for defining a service using the EC2 launch type.

Parameters:

cluster (ICluster) – The name of the cluster that hosts the service.
capacity_provider_strategies (Optional[Sequence[Union[CapacityProviderStrategy, Dict[str, Any]]]]) – A list of Capacity Provider strategies used to place a service. Default: - undefined
circuit_breaker (Union[DeploymentCircuitBreaker, Dict[str, Any], None]) – Whether to enable the deployment circuit breaker. If this property is defined, circuit breaker will be implicitly enabled. Default: - disabled
cloud_map_options (Union[CloudMapOptions, Dict[str, Any], None]) – The options for configuring an Amazon ECS service to use service discovery. Default: - AWS Cloud Map service discovery is not enabled.
deployment_controller (Union[DeploymentController, Dict[str, Any], None]) – Specifies which deployment controller to use for the service. For more information, see Amazon ECS Deployment Types Default: - Rolling update (ECS)
desired_count (Union[int, float, None]) – The desired number of instantiations of the task definition to keep running on the service. Default: - When creating the service, default is 1; when updating the service, default uses the current task number.
enable_ecs_managed_tags (Optional[bool]) – Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources Default: false
enable_execute_command (Optional[bool]) – Whether to enable the ability to execute into a container. Default: - undefined
health_check_grace_period (Optional[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. Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set
max_healthy_percent (Union[int, float, None]) – 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. Default: - 100 if daemon, otherwise 200
min_healthy_percent (Union[int, float, None]) – 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. Default: - 0 if daemon, otherwise 50
propagate_tags (Optional[PropagatedTagSource]) – 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 Default: PropagatedTagSource.NONE
propagate_task_tags_from (Optional[PropagatedTagSource]) – (deprecated) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. Tags can only be propagated to the tasks within the service during service creation. Default: PropagatedTagSource.NONE
service_name (Optional[str]) – The name of the service. Default: - CloudFormation-generated name.
task_definition (TaskDefinition) – The task definition to use for tasks in the service. [disable-awslint:ref-via-interface]
assign_public_ip (Optional[bool]) – Specifies whether the task’s elastic network interface receives a public IP address. If true, each task will receive a public IP address. This property is only used for tasks that use the awsvpc network mode. Default: false
daemon (Optional[bool]) – Specifies whether the service will use the daemon scheduling strategy. If true, the service scheduler deploys exactly one task on each container instance in your cluster. When you are using this strategy, do not specify a desired number of tasks orany task placement strategies. Default: false
placement_constraints (Optional[Sequence[PlacementConstraint]]) – The placement constraints to use for tasks in the service. For more information, see Amazon ECS Task Placement Constraints. Default: - No constraints.
placement_strategies (Optional[Sequence[PlacementStrategy]]) – The placement strategies to use for tasks in the service. For more information, see Amazon ECS Task Placement Strategies. Default: - No strategies.
security_group (Optional[ISecurityGroup]) – (deprecated) The security groups to associate with the service. If you do not specify a security group, a new security group is created. This property is only used for tasks that use the awsvpc network mode. Default: - A new security group is created.
security_groups (Optional[Sequence[ISecurityGroup]]) – The security groups to associate with the service. If you do not specify a security group, a new security group is created. This property is only used for tasks that use the awsvpc network mode. Default: - A new security group is created.
vpc_subnets (Union[SubnetSelection, Dict[str, Any], None]) – The subnets to associate with the service. This property is only used for tasks that use the awsvpc network mode. Default: - Public subnets if assignPublicIp is set, otherwise the first available one of Private, Isolated, Public, in that order.

ExampleMetadata:

infused

Example:

# cluster: ecs.Cluster
# task_definition: ecs.TaskDefinition
# vpc: ec2.Vpc

service = ecs.Ec2Service(self, "Service", cluster=cluster, task_definition=task_definition)

lb = elb.LoadBalancer(self, "LB", vpc=vpc)
lb.add_listener(external_port=80)
lb.add_target(service.load_balancer_target(
    container_name="MyContainer",
    container_port=80
))

Attributes

assign_public_ip

Specifies whether the task’s elastic network interface receives a public IP address.

If true, each task will receive a public IP address.

This property is only used for tasks that use the awsvpc network mode.

Default:: false

capacity_provider_strategies

A list of Capacity Provider strategies used to place a service.

Default:

undefined

circuit_breaker

Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.

Default:

disabled

cloud_map_options

The options for configuring an Amazon ECS service to use service discovery.

Default:

AWS Cloud Map service discovery is not enabled.

cluster: The name of the cluster that hosts the service.

daemon

Specifies whether the service will use the daemon scheduling strategy.

If true, the service scheduler deploys exactly one task on each container instance in your cluster.

When you are using this strategy, do not specify a desired number of tasks orany task placement strategies.

Default:: false

deployment_controller

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

Default:

Rolling update (ECS)

desired_count

The desired number of instantiations of the task definition to keep running on the service.

Default:

When creating the service, default is 1; when updating the service, default uses

the current task number.

enable_ecs_managed_tags

Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging Your Amazon ECS Resources

Default:: false

enable_execute_command

Whether to enable the ability to execute into a container.

Default:

undefined

health_check_grace_period

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.

Default:

defaults to 60 seconds if at least one load balancer is in-use and it is not already set

max_healthy_percent

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.

Default:

100 if daemon, otherwise 200

min_healthy_percent

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.

Default:

0 if daemon, otherwise 50

placement_constraints

The placement constraints to use for tasks in the service.

For more information, see Amazon ECS Task Placement Constraints.

Default:

No constraints.

placement_strategies

The placement strategies to use for tasks in the service.

For more information, see Amazon ECS Task Placement Strategies.

Default:

No strategies.

propagate_tags

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

Default:: PropagatedTagSource.NONE

propagate_task_tags_from

(deprecated) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

Tags can only be propagated to the tasks within the service during service creation.

Default:: PropagatedTagSource.NONE
Deprecated:: Use propagateTags instead.
Stability:: deprecated

security_group

(deprecated) The security groups to associate with the service.

If you do not specify a security group, a new security group is created.

This property is only used for tasks that use the awsvpc network mode.

Default:

A new security group is created.

Deprecated:

use securityGroups instead.

Stability:

deprecated

security_groups

The security groups to associate with the service.

If you do not specify a security group, a new security group is created.

This property is only used for tasks that use the awsvpc network mode.

Default:

A new security group is created.

service_name

The name of the service.

Default:

CloudFormation-generated name.

task_definition

The task definition to use for tasks in the service.

[disable-awslint:ref-via-interface]

vpc_subnets

The subnets to associate with the service.

This property is only used for tasks that use the awsvpc network mode.

Default:

Public subnets if assignPublicIp is set, otherwise the first available one of Private, Isolated, Public, in that order.