software.amazon.awscdk.services.ec2

Interface LookupMachineImageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LookupMachineImageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:09:26.372Z")
 @Stability(value=Stable)
public interface LookupMachineImageProps
extends software.amazon.jsii.JsiiSerializable

Properties for looking up an image.

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"));
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LookupMachineImageProps.Builder A builder for LookupMachineImageProps
static class	LookupMachineImageProps.Jsii$Proxy An implementation for LookupMachineImageProps

Method Summary

Modifier and Type	Method and Description
static LookupMachineImageProps.Builder	builder()
default Map<String,List<String>>	getFilters() Additional filters on the AMI.
String	getName() Name of the image (may contain wildcards).
default List<String>	getOwners() Owner account IDs or aliases.
default UserData	getUserData() Custom userdata for this image.
default Boolean	getWindows() Look for Windows images.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

Name of the image (may contain wildcards).

getFilters

@Stability(value=Stable)
 @Nullable
default Map<String,List<String>> getFilters()

Additional filters on the AMI.

Default: - No additional filters

See Also:

https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html

getOwners

@Stability(value=Stable)
 @Nullable
default List<String> getOwners()

Owner account IDs or aliases.

Default: - All owners

getUserData

@Stability(value=Stable)
 @Nullable
default UserData getUserData()

Custom userdata for this image.

Default: - Empty user data appropriate for the platform type

getWindows

@Stability(value=Stable)
 @Nullable
default Boolean getWindows()

Look for Windows images.

Default: false

builder

@Stability(value=Stable)
static LookupMachineImageProps.Builder builder()

Returns:

a LookupMachineImageProps.Builder of LookupMachineImageProps