Interface EcsOptimizedImageOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
EcsOptimizedImageOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:47.303Z") @Stability(Stable) public interface EcsOptimizedImageOptions extends software.amazon.jsii.JsiiSerializable
Additional configuration properties for EcsOptimizedImage factory functions.

Example:

 Vpc vpc;
 AutoScalingGroup autoScalingGroup = AutoScalingGroup.Builder.create(this, "ASG")
         .machineImage(EcsOptimizedImage.amazonLinux(EcsOptimizedImageOptions.builder().cachedInContext(true).build()))
         .vpc(vpc)
         .instanceType(new InstanceType("t2.micro"))
         .build();
 
  • Method Details

    • getCachedInContext

      @Stability(Stable) @Nullable default Boolean getCachedInContext()
      Whether the AMI ID is cached to be stable between deployments.

      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.

      Default: false

    • builder

      @Stability(Stable) static EcsOptimizedImageOptions.Builder builder()
      Returns:
      a EcsOptimizedImageOptions.Builder of EcsOptimizedImageOptions