NetworkMultipleTargetGroupsServiceBase
- class aws_cdk.aws_ecs_patterns.NetworkMultipleTargetGroupsServiceBase(scope, id, *, 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:
Construct
The base class for NetworkMultipleTargetGroupsEc2Service and NetworkMultipleTargetGroupsFargateService classes.
Constructs a new instance of the NetworkMultipleTargetGroupsServiceBase class.
- Parameters:
scope (
Construct
) –id (
str
) –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.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: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1; if true, the default is 1 for all new services and uses the existing services desired count when updating an existing service.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: falsehealth_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 setload_balancers (
Optional
[Sequence
[Union
[NetworkLoadBalancerProps
,Dict
[str
,Any
]]]]) – 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: - noneservice_name (
Optional
[str
]) – Name of the service. Default: - CloudFormation-generated name.target_groups (
Optional
[Sequence
[Union
[NetworkTargetProps
,Dict
[str
,Any
]]]]) – Properties to specify NLB target groups. Default: - default portMapping registered as target group and attached to the first defined listenertask_image_options (
Union
[NetworkLoadBalancedTaskImageProps
,Dict
[str
,Any
],None
]) – The properties required to create a new task definition. Only one of TaskDefinition or TaskImageOptions must be specified. Default: - nonevpc (
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.
Methods
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- cluster
The cluster that hosts the service.
- desired_count
(deprecated) The desired number of instantiations of the task definition to keep running on the service.
- Deprecated:
Use
internalDesiredCount
instead.
- Stability:
deprecated
- internal_desired_count
The desired number of instantiations of the task definition to keep running on the service.
The default is 1 for all new services and uses the existing services desired count when updating an existing service, if one is not provided.
- listener
The listener for the service.
- load_balancer
The Network Load Balancer for the service.
- node
The construct tree node associated with this construct.
Static Methods
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
) –- Return type:
bool