NetworkMultipleTargetGroupsServiceBaseProps

class aws_cdk.aws_ecs_patterns.NetworkMultipleTargetGroupsServiceBaseProps(*, cloud_map_options=None, cluster=None, desired_count=None, enable_ecs_managed_tags=None, health_check_grace_period=None, load_balancers=None, propagate_tags=None, service_name=None, target_groups=None, task_image_options=None, vpc=None)

Bases: object

The properties for the base NetworkMultipleTargetGroupsEc2Service or NetworkMultipleTargetGroupsFargateService service.

Parameters
  • cloud_map_options (Optional[CloudMapOptions]) – The options for configuring an Amazon ECS service to use service discovery. Default: - AWS Cloud Map service discovery is not enabled.

  • cluster (Optional[ICluster]) – The name of the cluster that hosts the service. If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc. Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

  • desired_count (Union[int, float, None]) – The desired number of instantiations of the task definition to keep running on the service. The minimum value is 1 Default: 1

  • 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

  • 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

  • load_balancers (Optional[List[NetworkLoadBalancerProps]]) – The network load balancer that will serve traffic to the service. Default: - a new load balancer with a listener will be created.

  • propagate_tags (Optional[PropagatedTagSource]) – 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: - none

  • service_name (Optional[str]) – Name of the service. Default: - CloudFormation-generated name.

  • target_groups (Optional[List[NetworkTargetProps]]) – Properties to specify NLB target groups. Default: - default portMapping registered as target group and attached to the first defined listener

  • task_image_options (Optional[NetworkLoadBalancedTaskImageProps]) – The properties required to create a new task definition. Only one of TaskDefinition or TaskImageOptions must be specified. Default: - none

  • vpc (Optional[IVpc]) – The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster. Default: - uses the VPC defined in the cluster or creates a new VPC.

Attributes

cloud_map_options

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

Default
  • AWS Cloud Map service discovery is not enabled.

Return type

Optional[CloudMapOptions]

cluster

The name of the cluster that hosts the service.

If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.

Default
  • create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

Return type

Optional[ICluster]

desired_count

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

The minimum value is 1

Default

1

Return type

Union[int, float, None]

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

Return type

Optional[bool]

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

Return type

Optional[Duration]

load_balancers

The network load balancer that will serve traffic to the service.

Default
  • a new load balancer with a listener will be created.

Return type

Optional[List[NetworkLoadBalancerProps]]

propagate_tags

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
  • none

Return type

Optional[PropagatedTagSource]

service_name

Name of the service.

Default
  • CloudFormation-generated name.

Return type

Optional[str]

target_groups

Properties to specify NLB target groups.

Default
  • default portMapping registered as target group and attached to the first defined listener

Return type

Optional[List[NetworkTargetProps]]

task_image_options

The properties required to create a new task definition.

Only one of TaskDefinition or TaskImageOptions must be specified.

Default
  • none

Return type

Optional[NetworkLoadBalancedTaskImageProps]

vpc

The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.

Default
  • uses the VPC defined in the cluster or creates a new VPC.

Return type

Optional[IVpc]