Package software.amazon.awscdk.services.ec2

Interface AmazonLinuxImageProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AmazonLinuxImageProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:18.628Z") @Stability(Stable) public interface AmazonLinuxImageProps extends software.amazon.jsii.JsiiSerializable
Amazon Linux image properties.

Example: 

 IVpc vpc;
 LoadBalancer lb = LoadBalancer.Builder.create(this, "LB")
         .vpc(vpc)
         .internetFacing(true)
         .build();
 // instance to add as the target for load balancer.
 Instance instance = Instance.Builder.create(this, "targetInstance")
         .vpc(vpc)
         .instanceType(InstanceType.of(InstanceClass.BURSTABLE2, InstanceSize.MICRO))
         .machineImage(AmazonLinuxImage.Builder.create().generation(AmazonLinuxGeneration.AMAZON_LINUX_2).build())
         .build();
 lb.addTarget(new InstanceTarget(instance));

  • Method Details

    • getAdditionalCacheKey

      @Stability(Stable) @Nullable default String getAdditionalCacheKey()
      Adds an additional discriminator to the cdk.context.json cache key.

      Default: - no additional cache key

    • 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

    • getCpuType

      @Stability(Stable) @Nullable default AmazonLinuxCpuType getCpuType()
      CPU Type.

      Default: X86_64

    • getEdition

      @Stability(Stable) @Nullable default AmazonLinuxEdition getEdition()
      What edition of Amazon Linux to use.

      Default: Standard

    • getGeneration

      @Stability(Stable) @Nullable default AmazonLinuxGeneration getGeneration()
      What generation of Amazon Linux to use.

      Default: AmazonLinux

    • getKernel

      @Stability(Stable) @Nullable default AmazonLinuxKernel getKernel()
      What kernel version of Amazon Linux to use.

      Default: -

    • getStorage

      @Stability(Stable) @Nullable default AmazonLinuxStorage getStorage()
      What storage backed image to use.

      Default: GeneralPurpose

    • getUserData

      @Stability(Stable) @Nullable default UserData getUserData()
      Initial user data.

      Default: - Empty UserData for Linux machines

    • getVirtualization

      @Stability(Stable) @Nullable default AmazonLinuxVirt getVirtualization()
      Virtualization type.

      Default: HVM

    • builder

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