Package software.amazon.awscdk.services.ecs

Class ExternalService

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ecs.BaseService

software.amazon.awscdk.services.ecs.ExternalService

All Implemented Interfaces:

IEnvironmentAware, IResource, IConnectable, IBaseService, IExternalService, IService, ILoadBalancerTarget, IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:09.705Z")
@Stability(Stable)
public class ExternalService
extends BaseService
implements IExternalService

This creates a service using the External launch type on an ECS cluster.

Example:

 Cluster cluster;
 TaskDefinition taskDefinition;
 Ec2Service.Builder.create(this, "Ec2Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .daemon(true)
         .build();
 ExternalService.Builder.create(this, "ExternalService")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .daemon(true)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ExternalService.Builder	A fluent builder for ExternalService.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationLoadBalancerTarget

IApplicationLoadBalancerTarget.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.IBaseService

IBaseService.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.IExternalService

IExternalService.Jsii$Default, IExternalService.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancing.ILoadBalancerTarget

ILoadBalancerTarget.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.INetworkLoadBalancerTarget

INetworkLoadBalancerTarget.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ExternalService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ExternalService(software.amazon.jsii.JsiiObjectRef objRef)
	ExternalService(software.constructs.Construct scope, String id, ExternalServiceProps props)	Constructs a new instance of the ExternalService class.

Method Summary

Modifier and Type	Method	Description
void	associateCloudMapService(AssociateCloudMapServiceOptions _options)	Overridden method to throw error as associateCloudMapService is not supported for external service.
LoadBalancerTargetProps	attachToApplicationTargetGroup(IApplicationTargetGroup _targetGroup)	Overridden method to throw error as attachToApplicationTargetGroup is not supported for external service.
ScalableTaskCount	autoScaleTaskCount(EnableScalingProps _props)	Overridden method to throw error as autoScaleTaskCount is not supported for external service.
protected void	configureAwsVpcNetworkingWithSecurityGroups(IVpc _vpc)	Overridden method to throw error as configureAwsVpcNetworkingWithSecurityGroups is not supported for external service.
protected void	configureAwsVpcNetworkingWithSecurityGroups(IVpc _vpc, Boolean _assignPublicIp)	Overridden method to throw error as configureAwsVpcNetworkingWithSecurityGroups is not supported for external service.
protected void	configureAwsVpcNetworkingWithSecurityGroups(IVpc _vpc, Boolean _assignPublicIp, SubnetSelection _vpcSubnets)	Overridden method to throw error as configureAwsVpcNetworkingWithSecurityGroups is not supported for external service.
protected void	configureAwsVpcNetworkingWithSecurityGroups(IVpc _vpc, Boolean _assignPublicIp, SubnetSelection _vpcSubnets, List<ISecurityGroup> _securityGroups)	Overridden method to throw error as configureAwsVpcNetworkingWithSecurityGroups is not supported for external service.
Service	enableCloudMap(CloudMapOptions _options)	Overridden method to throw error as enableCloudMap is not supported for external service.
static IExternalService	fromExternalServiceArn(software.constructs.Construct scope, String id, String externalServiceArn)	Imports from the specified service ARN.
static IBaseService	fromExternalServiceAttributes(software.constructs.Construct scope, String id, ExternalServiceAttributes attrs)	Imports from the specified service attributes.
IEcsLoadBalancerTarget	loadBalancerTarget(LoadBalancerTargetOptions _options)	Overridden method to throw error as loadBalancerTarget is not supported for external service.
void	registerLoadBalancerTargets(EcsTarget... _targets)	Overridden method to throw error as registerLoadBalancerTargets is not supported for external service.

Methods inherited from class software.amazon.awscdk.services.ecs.BaseService

addLifecycleHook, addVolume, attachToClassicLB, attachToNetworkTargetGroup, enableDeploymentAlarms, enableDeploymentAlarms, enableServiceConnect, enableServiceConnect, fromServiceArnWithCluster, getCloudmapService, getCloudMapService, getCluster, getConnections, getDeploymentAlarms, getLoadBalancers, getNetworkConfiguration, getServiceArn, getServiceName, getServiceRegistries, getTaskDefinition, isUsingECSDeploymentController, metric, metric, metricCpuUtilization, metricCpuUtilization, metricMemoryUtilization, metricMemoryUtilization, setCloudmapService, setDeploymentAlarms, setLoadBalancers, setNetworkConfiguration, setServiceRegistries

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.awscdk.services.ecs.IService

getServiceArn, getServiceName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

ExternalService

protected ExternalService(software.amazon.jsii.JsiiObjectRef objRef)

ExternalService

protected ExternalService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ExternalService

@Stability(Stable)
public ExternalService(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ExternalServiceProps props)

Constructs a new instance of the ExternalService class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromExternalServiceArn

@Stability(Stable)
@NotNull
public static IExternalService fromExternalServiceArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String externalServiceArn)

Imports from the specified service ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

externalServiceArn - This parameter is required.

fromExternalServiceAttributes

@Stability(Stable)
@NotNull
public static IBaseService fromExternalServiceAttributes(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 ExternalServiceAttributes attrs)

Imports from the specified service attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

associateCloudMapService

@Stability(Stable)
public void associateCloudMapService(@NotNull
 AssociateCloudMapServiceOptions _options)

Overridden method to throw error as associateCloudMapService is not supported for external service.

Overrides:

associateCloudMapService in class BaseService

Parameters:

_options - This parameter is required.

attachToApplicationTargetGroup

@Stability(Stable)
@NotNull
public LoadBalancerTargetProps attachToApplicationTargetGroup(@NotNull
 IApplicationTargetGroup _targetGroup)

Overridden method to throw error as attachToApplicationTargetGroup is not supported for external service.

Specified by:

attachToApplicationTargetGroup in interface IApplicationLoadBalancerTarget

Overrides:

attachToApplicationTargetGroup in class BaseService

Parameters:

_targetGroup - This parameter is required.

autoScaleTaskCount

@Stability(Stable)
@NotNull
public ScalableTaskCount autoScaleTaskCount(@NotNull
 EnableScalingProps _props)

Overridden method to throw error as autoScaleTaskCount is not supported for external service.

Overrides:

autoScaleTaskCount in class BaseService

Parameters:

_props - This parameter is required.

configureAwsVpcNetworkingWithSecurityGroups

@Stability(Stable)
protected void configureAwsVpcNetworkingWithSecurityGroups(@NotNull
 IVpc _vpc,
 @Nullable
 Boolean _assignPublicIp,
 @Nullable
 SubnetSelection _vpcSubnets,
 @Nullable
 List<ISecurityGroup> _securityGroups)

Overridden method to throw error as configureAwsVpcNetworkingWithSecurityGroups is not supported for external service.

Overrides:

configureAwsVpcNetworkingWithSecurityGroups in class BaseService

Parameters:

_vpc - This parameter is required.

_assignPublicIp -

_vpcSubnets -

_securityGroups -

configureAwsVpcNetworkingWithSecurityGroups

@Stability(Stable)
protected void configureAwsVpcNetworkingWithSecurityGroups(@NotNull
 IVpc _vpc,
 @Nullable
 Boolean _assignPublicIp,
 @Nullable
 SubnetSelection _vpcSubnets)

Overridden method to throw error as configureAwsVpcNetworkingWithSecurityGroups is not supported for external service.

Overrides:

configureAwsVpcNetworkingWithSecurityGroups in class BaseService

Parameters:

_vpc - This parameter is required.

_assignPublicIp -

_vpcSubnets -

configureAwsVpcNetworkingWithSecurityGroups

@Stability(Stable)
protected void configureAwsVpcNetworkingWithSecurityGroups(@NotNull
 IVpc _vpc,
 @Nullable
 Boolean _assignPublicIp)

Overridden method to throw error as configureAwsVpcNetworkingWithSecurityGroups is not supported for external service.

Overrides:

configureAwsVpcNetworkingWithSecurityGroups in class BaseService

Parameters:

_vpc - This parameter is required.

_assignPublicIp -

configureAwsVpcNetworkingWithSecurityGroups

@Stability(Stable)
protected void configureAwsVpcNetworkingWithSecurityGroups(@NotNull
 IVpc _vpc)

Overridden method to throw error as configureAwsVpcNetworkingWithSecurityGroups is not supported for external service.

Overrides:

configureAwsVpcNetworkingWithSecurityGroups in class BaseService

Parameters:

_vpc - This parameter is required.

enableCloudMap

@Stability(Stable)
@NotNull
public Service enableCloudMap(@NotNull
 CloudMapOptions _options)

Overridden method to throw error as enableCloudMap is not supported for external service.

Overrides:

enableCloudMap in class BaseService

Parameters:

_options - This parameter is required.

Returns:

The created CloudMap service

loadBalancerTarget

@Stability(Stable)
@NotNull
public IEcsLoadBalancerTarget loadBalancerTarget(@NotNull
 LoadBalancerTargetOptions _options)

Overridden method to throw error as loadBalancerTarget is not supported for external service.

Overrides:

loadBalancerTarget in class BaseService

Parameters:

_options - This parameter is required.

registerLoadBalancerTargets

@Stability(Stable)
public void registerLoadBalancerTargets(@NotNull
 EcsTarget... _targets)

Overridden method to throw error as registerLoadBalancerTargets is not supported for external service.

Overrides:

registerLoadBalancerTargets in class BaseService

Parameters:

_targets - This parameter is required.