Package software.amazon.awscdk.services.ec2

Interface SsmParameterImageOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
SsmParameterImageOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-20T23:37:19.427Z") @Stability(Stable) public interface SsmParameterImageOptions extends software.amazon.jsii.JsiiSerializable
Properties for GenericSsmParameterImage.

Example: 

 // Pick the right Amazon Linux edition. All arguments shown are optional
 // and will default to these values when omitted.
 IMachineImage amznLinux = MachineImage.latestAmazonLinux(AmazonLinuxImageProps.builder()
         .generation(AmazonLinuxGeneration.AMAZON_LINUX)
         .edition(AmazonLinuxEdition.STANDARD)
         .virtualization(AmazonLinuxVirt.HVM)
         .storage(AmazonLinuxStorage.GENERAL_PURPOSE)
         .cpuType(AmazonLinuxCpuType.X86_64)
         .build());
 // Pick a Windows edition to use
 IMachineImage windows = MachineImage.latestWindows(WindowsVersion.WINDOWS_SERVER_2019_ENGLISH_FULL_BASE);
 // Read AMI id from SSM parameter store
 IMachineImage ssm = MachineImage.fromSsmParameter("/my/ami", SsmParameterImageOptions.builder().os(OperatingSystemType.LINUX).build());
 // Look up the most recent image matching a set of AMI filters.
 // In this case, look up the NAT instance AMI, by using a wildcard
 // in the 'name' field:
 IMachineImage natAmi = MachineImage.lookup(LookupMachineImageProps.builder()
         .name("amzn-ami-vpc-nat-*")
         .owners(List.of("amazon"))
         .build());
 // For other custom (Linux) images, instantiate a `GenericLinuxImage` with
 // a map giving the AMI to in for each region:
 IMachineImage linux = MachineImage.genericLinux(Map.of(
         "us-east-1", "ami-97785bed",
         "eu-west-1", "ami-12345678"));
 // For other custom (Windows) images, instantiate a `GenericWindowsImage` with
 // a map giving the AMI to in for each region:
 IMachineImage genericWindows = MachineImage.genericWindows(Map.of(
         "us-east-1", "ami-97785bed",
         "eu-west-1", "ami-12345678"));

  • 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

    • getOs

      @Stability(Stable) @Nullable default OperatingSystemType getOs()
      Operating system.

      Default: OperatingSystemType.LINUX

    • getParameterVersion

      @Stability(Stable) @Nullable default String getParameterVersion()
      The version of the SSM parameter.

      Default: no version specified.

    • getUserData

      @Stability(Stable) @Nullable default UserData getUserData()
      Custom UserData.

      Default: - UserData appropriate for the OS

    • builder

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