class ExternalService (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.ECS.ExternalService`
Java	`software.amazon.awscdk.services.ecs.ExternalService`
Python	`aws_cdk.aws_ecs.ExternalService`
TypeScript (source)	`@aws-cdk/aws-ecs` » `ExternalService`

Implements IConstruct, IConstruct, IDependable, IResource, IBaseService, IService, IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget, ILoadBalancerTarget, IConnectable, IExternalService

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

Example

declare const cluster: ecs.Cluster;
declare const taskDefinition: ecs.TaskDefinition;

const service = new ecs.ExternalService(this, 'Service', {
  cluster,
  taskDefinition,
  desiredCount: 5,
});

Initializer

new ExternalService(scope: Construct, id: string, props: ExternalServiceProps)

Parameters

scope Construct
id string
props ExternalServiceProps

Constructs a new instance of the ExternalService class.

Construct Props

Name	Type	Description
cluster	`ICluster`	The name of the cluster that hosts the service.
taskDefinition	`TaskDefinition`	The task definition to use for tasks in the service.
capacityProviderStrategies?	`CapacityProviderStrategy[]`	A list of Capacity Provider strategies used to place a service.
circuitBreaker?	`DeploymentCircuitBreaker`	Whether to enable the deployment circuit breaker.
cloudMapOptions?	`CloudMapOptions`	The options for configuring an Amazon ECS service to use service discovery.
deploymentController?	`DeploymentController`	Specifies which deployment controller to use for the service.
desiredCount?	`number`	The desired number of instantiations of the task definition to keep running on the service.
enableECSManagedTags?	`boolean`	Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
enableExecuteCommand?	`boolean`	Whether to enable the ability to execute into a container.
healthCheckGracePeriod?	`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.
maxHealthyPercent?	`number`	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.
minHealthyPercent?	`number`	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.
propagateTags?	`PropagatedTagSource`	Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
propagateTaskTagsFrom?⚠️	`PropagatedTagSource`	Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
securityGroups?	`ISecurityGroup[]`	The security groups to associate with the service.
serviceName?	`string`	The name of the service.

cluster

Type: ICluster

The name of the cluster that hosts the service.

taskDefinition

Type: TaskDefinition

The task definition to use for tasks in the service.

[disable-awslint:ref-via-interface]

capacityProviderStrategies?

Type: CapacityProviderStrategy[] (optional, default: undefined)

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

circuitBreaker?

Type: DeploymentCircuitBreaker (optional, default: disabled)

Whether to enable the deployment circuit breaker.

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

cloudMapOptions?

Type: CloudMapOptions (optional, default: AWS Cloud Map service discovery is not enabled.)

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

deploymentController?

Type: DeploymentController (optional, default: Rolling update (ECS))

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

desiredCount?

Type: number (optional, default: When creating the service, default is 1; when updating the service, default uses the current task number.)

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

enableECSManagedTags?

Type: boolean (optional, default: false)

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

For more information, see Tagging Your Amazon ECS Resources

enableExecuteCommand?

Type: boolean (optional, default: undefined)

Whether to enable the ability to execute into a container.

healthCheckGracePeriod?

Type: Duration (optional, default: defaults to 60 seconds if at least one load balancer is in-use and it is not already set)

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.

maxHealthyPercent?

Type: number (optional, default: 100 if daemon, otherwise 200)

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.

minHealthyPercent?

Type: number (optional, default: 0 if daemon, otherwise 50)

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.

propagateTags?

Type: PropagatedTagSource (optional, default: PropagatedTagSource.NONE)

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

propagateTaskTagsFrom?⚠️

⚠️ Deprecated: Use propagateTags instead.

Type: PropagatedTagSource (optional, default: PropagatedTagSource.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.

securityGroups?

Type: ISecurityGroup[] (optional, default: A new security group is created.)

The security groups to associate with the service.

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

serviceName?

Type: string (optional, default: CloudFormation-generated name.)

The name of the service.

Properties

Name	Type	Description
cluster	`ICluster`	The cluster that hosts the service.
connections	`Connections`	The security groups which manage the allowed network traffic for the service.
env	`ResourceEnvironment`	The environment this resource belongs to.
node	`ConstructNode`	The construct tree node associated with this construct.
serviceArn	`string`	The Amazon Resource Name (ARN) of the service.
serviceName	`string`	The name of the service.
stack	`Stack`	The stack in which this resource is defined.
taskDefinition	`TaskDefinition`	The task definition to use for tasks in the service.
cloudMapService?	`IService`	The CloudMap service created for this service, if any.

cluster

Type: ICluster

The cluster that hosts the service.

connections

Type: Connections

The security groups which manage the allowed network traffic for the service.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

Type: ConstructNode

The construct tree node associated with this construct.

serviceArn

Type: string

The Amazon Resource Name (ARN) of the service.

serviceName

Type: string

The name of the service.

stack

Type: Stack

The stack in which this resource is defined.

taskDefinition

Type: TaskDefinition

The task definition to use for tasks in the service.

cloudMapService?

Type: IService (optional)

The CloudMap service created for this service, if any.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
associateCloudMapService(_options)	Overriden method to throw error as `associateCloudMapService` is not supported for external service.
attachToApplicationTargetGroup(_targetGroup)	Overriden method to throw error as `attachToApplicationTargetGroup` is not supported for external service.
attachToClassicLB(loadBalancer)	Registers the service as a target of a Classic Load Balancer (CLB).
attachToNetworkTargetGroup(targetGroup)	This method is called to attach this service to a Network Load Balancer.
autoScaleTaskCount(_props)	Overriden method to throw error as `autoScaleTaskCount` is not supported for external service.
enableCloudMap(_options)	Overriden method to throw error as `enableCloudMap` is not supported for external service.
loadBalancerTarget(_options)	Overriden method to throw error as `loadBalancerTarget` is not supported for external service.
metric(metricName, props?)	This method returns the specified CloudWatch metric name for this service.
metricCpuUtilization(props?)	This method returns the CloudWatch metric for this service's CPU utilization.
metricMemoryUtilization(props?)	This method returns the CloudWatch metric for this service's memory utilization.
registerLoadBalancerTargets(..._targets)	Overriden method to throw error as `registerLoadBalancerTargets` is not supported for external service.
toString()	Returns a string representation of this construct.
protected configureAwsVpcNetworkingWithSecurityGroups(_vpc, _assignPublicIp?, _vpcSubnets?, _securityGroups?)	Overriden method to throw error as `configureAwsVpcNetworkingWithSecurityGroups` is not supported for external service.
static fromExternalServiceArn(scope, id, externalServiceArn)	Imports from the specified service ARN.
static fromExternalServiceAttributes(scope, id, attrs)	Imports from the specified service attributes.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

associateCloudMapService(_options)

public associateCloudMapService(_options: AssociateCloudMapServiceOptions): void

Parameters

_options AssociateCloudMapServiceOptions

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

attachToApplicationTargetGroup(_targetGroup)

public attachToApplicationTargetGroup(_targetGroup: IApplicationTargetGroup): LoadBalancerTargetProps

Parameters

_targetGroup IApplicationTargetGroup

Returns

LoadBalancerTargetProps

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

attachToClassicLB(loadBalancer)

public attachToClassicLB(loadBalancer: LoadBalancer): void

Parameters

loadBalancer LoadBalancer

Registers the service as a target of a Classic Load Balancer (CLB).

Don't call this. Call loadBalancer.addTarget() instead.

attachToNetworkTargetGroup(targetGroup)

public attachToNetworkTargetGroup(targetGroup: INetworkTargetGroup): LoadBalancerTargetProps

Parameters

targetGroup INetworkTargetGroup

Returns

LoadBalancerTargetProps

This method is called to attach this service to a Network Load Balancer.

Don't call this function directly. Instead, call listener.addTargets() to add this service to a load balancer.

autoScaleTaskCount(_props)

public autoScaleTaskCount(_props: EnableScalingProps): ScalableTaskCount

Parameters

_props EnableScalingProps

Returns

ScalableTaskCount

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

enableCloudMap(_options)

public enableCloudMap(_options: CloudMapOptions): Service

Parameters

_options CloudMapOptions

Returns

Service

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

loadBalancerTarget(_options)

public loadBalancerTarget(_options: LoadBalancerTargetOptions): IEcsLoadBalancerTarget

Parameters

_options LoadBalancerTargetOptions

Returns

IEcsLoadBalancerTarget

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

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

metricName string
props MetricOptions

Returns

Metric

This method returns the specified CloudWatch metric name for this service.

metricCpuUtilization(props?)

public metricCpuUtilization(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

This method returns the CloudWatch metric for this service's CPU utilization.

metricMemoryUtilization(props?)

public metricMemoryUtilization(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

This method returns the CloudWatch metric for this service's memory utilization.

registerLoadBalancerTargets(..._targets)

public registerLoadBalancerTargets(..._targets: EcsTarget[]): void

Parameters

_targets EcsTarget

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

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected configureAwsVpcNetworkingWithSecurityGroups(_vpc, _assignPublicIp?, _vpcSubnets?, _securityGroups?)

protected configureAwsVpcNetworkingWithSecurityGroups(_vpc: IVpc, _assignPublicIp?: boolean, _vpcSubnets?: SubnetSelection, _securityGroups?: ISecurityGroup[]): void

Parameters

_vpc IVpc
_assignPublicIp boolean
_vpcSubnets SubnetSelection
_securityGroups ISecurityGroup[]

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

static fromExternalServiceArn(scope, id, externalServiceArn)

public static fromExternalServiceArn(scope: Construct, id: string, externalServiceArn: string): IExternalService

Parameters

scope Construct
id string
externalServiceArn string

Returns

IExternalService

Imports from the specified service ARN.

static fromExternalServiceAttributes(scope, id, attrs)

public static fromExternalServiceAttributes(scope: Construct, id: string, attrs: ExternalServiceAttributes): IBaseService

Parameters

scope Construct
id string
attrs ExternalServiceAttributes

Returns

IBaseService

Imports from the specified service attributes.