class ScalableTaskCount (construct)

Language	Type name
.NET	Amazon.CDK.AWS.ECS.ScalableTaskCount
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsecs#ScalableTaskCount
Java	software.amazon.awscdk.services.ecs.ScalableTaskCount
Python	aws_cdk.aws_ecs.ScalableTaskCount
TypeScript (source)	aws-cdk-lib » aws_ecs » ScalableTaskCount

Implements IConstruct, IDependable, IScalableTargetRef, IEnvironmentAware

The scalable attribute representing task count.

Example

declare const cluster: ecs.Cluster;
const loadBalancedFargateService = new ecsPatterns.ApplicationLoadBalancedFargateService(this, 'Service', {
  cluster,
  memoryLimitMiB: 1024,
  desiredCount: 1,
  cpu: 512,
  taskImageOptions: {
    image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
  },
  minHealthyPercent: 100,
});

const scalableTarget = loadBalancedFargateService.service.autoScaleTaskCount({
  minCapacity: 1,
  maxCapacity: 20,
});

scalableTarget.scaleOnCpuUtilization('CpuScaling', {
  targetUtilizationPercent: 50,
});

scalableTarget.scaleOnMemoryUtilization('MemoryScaling', {
  targetUtilizationPercent: 50,
});

Initializer

new ScalableTaskCount(scope: Construct, id: string, props: ScalableTaskCountProps)

Parameters

• scope Construct
• id string
• props ScalableTaskCountProps

Constructs a new instance of the ScalableTaskCount class.

Construct Props

Name	Type	Description
dimension	string	Scalable dimension of the attribute.
maxCapacity	number	Maximum capacity to scale to.
resourceId	string	Resource ID of the attribute.
role	IRole	Role to use for scaling.
serviceNamespace	ServiceNamespace	Service namespace of the scalable attribute.
minCapacity?	number	Minimum capacity to scale to.

---

dimension

Type: string

Scalable dimension of the attribute.

---

maxCapacity

Type: number

Maximum capacity to scale to.

---

resourceId

Type: string

Resource ID of the attribute.

---

role

Type: IRole

Role to use for scaling.

---

serviceNamespace

Type: ServiceNamespace

Service namespace of the scalable attribute.

---

minCapacity?

Type: number (optional, default: 1)

Minimum capacity to scale to.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
node	Node	The tree node.
scalableTargetRef	ScalableTargetReference	A reference to a ScalableTarget resource.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node

Type: Node

The tree node.

---

scalableTargetRef

Type: ScalableTargetReference

A reference to a ScalableTarget resource.

Methods

Name	Description
scaleOnCpuUtilization(id, props)	Scales in or out to achieve a target CPU utilization.
scaleOnMemoryUtilization(id, props)	Scales in or out to achieve a target memory utilization.
scaleOnMetric(id, props)	Scales in or out based on a specified metric value.
scaleOnRequestCount(id, props)	Scales in or out to achieve a target Application Load Balancer request count per target.
scaleOnSchedule(id, props)	Scales in or out based on a specified scheduled time.
scaleToTrackCustomMetric(id, props)	Scales in or out to achieve a target on a custom metric.
toString()	Returns a string representation of this construct.

---

scaleOnCpuUtilization(id, props)

public scaleOnCpuUtilization(id: string, props: CpuUtilizationScalingProps): void

Parameters

• id string
• props CpuUtilizationScalingProps

Scales in or out to achieve a target CPU utilization.

---

scaleOnMemoryUtilization(id, props)

public scaleOnMemoryUtilization(id: string, props: MemoryUtilizationScalingProps): void

Parameters

• id string
• props MemoryUtilizationScalingProps

Scales in or out to achieve a target memory utilization.

---

scaleOnMetric(id, props)

public scaleOnMetric(id: string, props: BasicStepScalingPolicyProps): void

Parameters

• id string
• props BasicStepScalingPolicyProps

Scales in or out based on a specified metric value.

---

scaleOnRequestCount(id, props)

public scaleOnRequestCount(id: string, props: RequestCountScalingProps): void

Parameters

• id string
• props RequestCountScalingProps

Scales in or out to achieve a target Application Load Balancer request count per target.

---

scaleOnSchedule(id, props)

public scaleOnSchedule(id: string, props: ScalingSchedule): void

Parameters

• id string
• props ScalingSchedule

Scales in or out based on a specified scheduled time.

---

scaleToTrackCustomMetric(id, props)

public scaleToTrackCustomMetric(id: string, props: TrackCustomMetricProps): void

Parameters

• id string
• props TrackCustomMetricProps

Scales in or out to achieve a target on a custom metric.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.