Skip to content
v2.274.0

NetworkMultipleTargetGroupsServiceBase L3 construct ​

The base class for NetworkMultipleTargetGroupsEc2Service and NetworkMultipleTargetGroupsFargateService classes.

Initializer ​

ts
new NetworkMultipleTargetGroupsServiceBase(scope: Construct, id: string, props?: NetworkMultipleTargetGroupsServiceBaseProps)
python
NetworkMultipleTargetGroupsServiceBase(scope: Construct, id: str, props: typing.Optional[NetworkMultipleTargetGroupsServiceBaseProps] = None)
java
new NetworkMultipleTargetGroupsServiceBase(Construct scope, String id, NetworkMultipleTargetGroupsServiceBaseProps props)
csharp
new NetworkMultipleTargetGroupsServiceBase(Construct scope, string id, NetworkMultipleTargetGroupsServiceBaseProps? props = null)
go
NewNetworkMultipleTargetGroupsServiceBase(Scope Construct, Id *string, Props NetworkMultipleTargetGroupsServiceBaseProps)

Construct Props ​

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

Default: AWS Cloud Map service discovery is not enabled.

clusteroptionalIClusterclusteroptionalIClusterclusteroptionalIClusterClusteroptionalIClusterClusteroptionalICluster#
The name of the cluster that hosts the service.

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

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

desiredCountoptionalnumberdesired_countoptionalint | floatdesiredCountoptionalNumberDesiredCountoptionaldoubleDesiredCountoptional*float64#
The desired number of instantiations of the task definition to keep running on the service.

Default: The default is 1 for all new services and uses the existing service's desired count when updating an existing service.

The minimum value is 1

enableECSManagedTagsoptionalbooleanenable_ecs_managed_tagsoptionalboolenableECSManagedTagsoptionalBooleanEnableECSManagedTagsoptionalboolEnableECSManagedTagsoptional*bool= false#
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging Your Amazon ECS Resources

enableExecuteCommandoptionalbooleanenable_execute_commandoptionalboolenableExecuteCommandoptionalBooleanEnableExecuteCommandoptionalboolEnableExecuteCommandoptional*bool= false#
Whether ECS Exec should be enabled.
healthCheckGracePeriodoptionalDurationhealth_check_grace_periodoptionalDurationhealthCheckGracePeriodoptionalDurationHealthCheckGracePeriodoptionalDurationHealthCheckGracePeriodoptionalDuration#
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

loadBalancersoptionalNetworkLoadBalancerProps[]load_balancersoptionaltyping.List[NetworkLoadBalancerProps]loadBalancersoptionalList<NetworkLoadBalancerProps>LoadBalancersoptionalNetworkLoadBalancerProps[]LoadBalancersoptional*[]NetworkLoadBalancerProps#
The network load balancer that will serve traffic to the service.

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

propagateTagsoptionalPropagatedTagSourcepropagate_tagsoptionalPropagatedTagSourcepropagateTagsoptionalPropagatedTagSourcePropagateTagsoptionalPropagatedTagSourcePropagateTagsoptionalPropagatedTagSource= none#
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.

serviceNameoptionalstringservice_nameoptionalstrserviceNameoptionalStringServiceNameoptionalstringServiceNameoptional*string#
Name of the service.

Default: CloudFormation-generated name.

targetGroupsoptionalNetworkTargetProps[]target_groupsoptionaltyping.List[NetworkTargetProps]targetGroupsoptionalList<NetworkTargetProps>TargetGroupsoptionalNetworkTargetProps[]TargetGroupsoptional*[]NetworkTargetProps#
Properties to specify NLB target groups.

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

taskImageOptionsoptionalNetworkLoadBalancedTaskImagePropstask_image_optionsoptionalNetworkLoadBalancedTaskImagePropstaskImageOptionsoptionalNetworkLoadBalancedTaskImagePropsTaskImageOptionsoptionalNetworkLoadBalancedTaskImagePropsTaskImageOptionsoptionalNetworkLoadBalancedTaskImageProps= none#
The properties required to create a new task definition.

Only one of TaskDefinition or TaskImageOptions must be specified.

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

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

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

Properties ​

clusterIClusterclusterIClusterclusterIClusterClusterIClusterClusterIClusterrequired#
The cluster that hosts the service.
internalDesiredCountmay be undefinednumberinternal_desired_countmay be undefinedint | floatinternalDesiredCountmay be undefinedNumberInternalDesiredCountmay be undefineddoubleInternalDesiredCountmay be undefined*float64#
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.

listenerNetworkListenerlistenerNetworkListenerlistenerNetworkListenerListenerNetworkListenerListenerNetworkListenerrequireddeprecated#
- Use `listeners` instead.
listenersNetworkListener[]listenerstyping.List[NetworkListener]listenersList<NetworkListener>ListenersNetworkListener[]Listeners*[]NetworkListenerrequired#
The listeners of the service.
loadBalancerNetworkLoadBalancerload_balancerNetworkLoadBalancerloadBalancerNetworkLoadBalancerLoadBalancerNetworkLoadBalancerLoadBalancerNetworkLoadBalancerrequireddeprecated#
- Use `loadBalancers` instead.
loadBalancersNetworkLoadBalancer[]load_balancerstyping.List[NetworkLoadBalancer]loadBalancersList<NetworkLoadBalancer>LoadBalancersNetworkLoadBalancer[]LoadBalancers*[]NetworkLoadBalancerrequired#
The load balancers of the service.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
targetGroupsNetworkTargetGroup[]target_groupstyping.List[NetworkTargetGroup]targetGroupsList<NetworkTargetGroup>TargetGroupsNetworkTargetGroup[]TargetGroups*[]NetworkTargetGrouprequired#
The target groups of the service.

Methods ​

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining