aws-cdk-lib.aws_ecs.EcsOptimizedImageOptions

EcsOptimizedImageOptions Struct

Additional configuration properties for EcsOptimizedImage factory functions.

Source

aws-ecs/lib/amis.ts

Type last changed

v2.201.0 · 13 Jun 2025

Example

declare const vpc: ec2.Vpc;
const autoScalingGroup = new autoscaling.AutoScalingGroup(this, 'ASG', {
  machineImage: ecs.EcsOptimizedImage.amazonLinux({ cachedInContext: true }),
  vpc,
  instanceType: new ec2.InstanceType('t2.micro'),
});

Properties

additionalCacheKey?optionalstringadditional_cache_key?optionalstradditionalCacheKey?optionalStringAdditionalCacheKey?optionalstringAdditionalCacheKey?optional*string#

Adds an additional discriminator to the `cdk.context.json` cache key.

Default: no additional cache key

cachedInContext?optionalbooleancached_in_context?optionalboolcachedInContext?optionalBooleanCachedInContext?optionalboolCachedInContext?optional*bool= false#

Whether the AMI ID is cached to be stable between deployments.

notes

By default, the newest image is used on each deployment. This will cause instances to be replaced whenever a new version is released, and may cause downtime if there aren't enough running instances in the AutoScalingGroup to reschedule the tasks on.

If set to true, the AMI ID will be cached in cdk.context.json and the same value will be used on future runs. Your instances will not be replaced but your AMI version will grow old over time. To refresh the AMI lookup, you will have to evict the value from the cache using the cdk context command. See https://docs.aws.amazon.com/cdk/latest/guide/context.html for more information.

Can not be set to true in environment-agnostic stacks.